diff --git a/README.md b/README.md index 2ecc477..5e25b26 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@

GitHub tag (with filter) Pypthon version - CI + CI + Build Coverage Status Code Quality Project license @@ -23,34 +24,40 @@ Here is a list of the dog states: *idle*, *idle and bark*, *walk*, *walk and bar **Project context**: A colleague of mine wanted to have a dog, but he couldn't because of lots of reasons. So I decided to make him a virtual dog and it was the opportunity for me to play with Markov chains.

- 📦⇩ Download latest release ⇩📦 + 📦 ⇩ Download latest release ⇩📦 +
+ Note: release binaries are generated from the release workflow and are unsigned. You may need to allow the execution of the binary in your system settings.

-## Run - -**Doggo** use [poetry](https://python-poetry.org/) to manage dependencies and virtual environment. - -```bash -poetry install -poetry run python -m doggo -``` - ### Interactions The project is designed as a simple pet widget to keep on your desktop. It's an always-on-top borderless window, so you need to click on it to get the focus before interacting with it. +**Controls**: + * `ESC` to quit. * `Left Click` to move the window around. -## Packaging +## Install and run -If you want to package the project locally, you can use the script in `scripts/build.py`. It uses [PyInstaller](https://www.pyinstaller.org/) under the hood. Don't hesitate to update the script to fit your needs. +Make sure you have Python 3.12 installed on your machine. **Doggo** use [poetry](https://python-poetry.org/) to manage dependencies and virtual environment, so you need to install it too. Then, you can run the following commands at the root of the project: ```bash -# Available os options: win32 , win64 +poetry install +poetry run python -m doggo +``` + +## Build locally + +If you want to build the project locally, you can use the script in `scripts/build.py`. It uses [PyInstaller](https://www.pyinstaller.org/) under the hood. Don't hesitate to update the script to fit your needs. + +```bash +# Available os options: windows, linux, macos poetry run python scripts/build.py --os ``` +The script will generate a `dist` folder at the root of the project with the executable inside. + ## Development For now, only one biome (mountain) is available. The feature to pick a biome randomly at start is already implemented, so I wish to add more in the future. Otherwise, I don't plan to add more features, like weathers or interactions, but the project is open to contributions. Just open a discussion before to make sure your idea fits the project.