Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify README for end-user #21

Merged
merged 1 commit into from
Dec 18, 2023
Merged

Clarify README for end-user #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading