-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README.md): expand documentation with download links, usage inst…
…ructions, build from source guide, contribution and license info to provide more comprehensive information for users and contributors
- Loading branch information
Showing
1 changed file
with
59 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,8 +7,66 @@ A lightweight Discord custom Rich Presence manager that runs on Linux and Window | |
<p align="center"> | ||
<img src="https://github.com/dinogomez/genzai/assets/41871666/0d384431-5226-491f-baca-8a1c075b06ce"> | ||
|
||
## Installation | ||
## Download | ||
|
||
### Latest | ||
|
||
The latest official release of Genzai is available for both Linux and Windows. Check the [Genzai Latest Release](https://github.com/dinogomez/genzai/releases/tag/Latest). | ||
|
||
- [Download for Linux](https://github.com/dinogomez/genzai/releases/download/Latest/genzai-linux.zip) | ||
- [Download for Windows](https://github.com/dinogomez/genzai/releases/download/Latest/genzai-windows.zip) | ||
|
||
## How to use Genzai? | ||
|
||
1. Make a new Discord application [here](https://discord.com/developers/applications). | ||
2. Copy the `Client ID` and paste it in the `Client ID` field in Genzai. | ||
3. Click `Connect` | ||
4. Fill out the fields you want. | ||
5. Click `Update` | ||
6. Enjoy your new Discord Rich Presence! | ||
|
||
## How to build Genzai from source | ||
|
||
Clone the repository and cd into it. | ||
|
||
```bash | ||
$ git clone [email protected]:dinogomez/genzai.git | ||
$ cd genzai | ||
``` | ||
|
||
Install the python requirements via pip | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
``` | ||
|
||
I advice building the application with `auto-py-to-exe` or `pyinstaller` to avoid any issues with missing dependencies. | ||
|
||
With `auto-py-to-exe`. | ||
|
||
1. Select `One Directory` | ||
2. Select `Window Based` | ||
3. Select `Add Folder` and add the `genzai/assets` folder | ||
4. Select `Add Folder` and add `customtkinter` package. | ||
|
||
> Use `pip show customtkinter` to find the location of the package. | ||
5. Add the `PIL._tkinter_finder` hidden import | ||
6. Select `Convert .py to .exe` and wait for the build to finish | ||
7. Run the `genzai.exe` file in the `output` folder | ||
<br> | ||
<br> | ||
|
||
With `pyinstaller`, refer to this [documentation](https://customtkinter.tomschimansky.com/documentation/packaging) when building customtkinter apps. | ||
|
||
```bash | ||
pyinstaller --noconfirm --onedir --windowed --icon "<Genzai Location>/Genzai/assets/genzai.ico" --add-data "<CustomTkinter Location>/customtkinter:customtkinter/" --add-data "<Genzai Location>/Genzai/assets:assets/" --hidden-import "PIL._tkinter_finder" "<Genzai Location>/Genzai/genzai.py" | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! Please open an issue or submit a pull request. | ||
|
||
## License | ||
|
||
This project is licensed under the [MIT License](https://github.com/dinogomez/genzai/blob/main/LICENSE) |