diff --git a/README.md b/README.md index 3c1f83a..5e991a1 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,25 @@ # 🐕 doggo

GitHub tag (with filter) + Pypthon version CI Coverage Status Code Quality Project license

+## ⚙️ Run -## Licenses +**doggo** use [poetry](https://python-poetry.org/) to manage dependencies and virtual environment. -* Code source under GPL-3.0 License -* Dog sprites source from [Benvictus](https://benvictus.itch.io/pixel-dogs) +```bash +$ poetry install +$ poetry run python -m doggo +``` + +## 📝 Licenses + +* Code source under [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html) +* Assets: + * Dog sprites in `src/doggo/assets/dogs` by [Benvictus](https://benvictus.itch.io/pixel-dogs) + * Landscape sprites in `src/doggo/assets/landscapes` under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)