diff --git a/README.md b/README.md index 3ea9ae20..fe0f5605 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,14 @@ Features Done ### 🏠 [Homepage](https://github.com/KotRikD/tosu#readme) +### For end-user +We provide a packaged exe with everything you need to run `tosu`, to do so go to [latest release](https://github.com/KotRikD/tosu/releases/latest) and download required archive.\ +You need unpack it to folder, and if you need overlays, download the [Blackshark/static](https://github.com/l3lackShark/static) repo and unpack it to `static` folder. After that you should be ready to go! + +`tosu` also provides in-game overlay based on gosumemory one. To enable it, you need to edit `tosu.env`, and turn on `ENABLE_GOSU_OVERLA=true` (make it equal `true`) + +# Everything below in README is needed for project development + ## Prerequisites - typescript >=4.9.5