lucaspalomodevelop/binbreak
1
0
Fork 0
mirror of https://github.com/lucaspalomodevelop/binbreak.git synced 2026-03-13 00:07:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README with installation instructions for Linux and building from source

Browse Source
This commit is contained in:
epic-64 2025-11-08 00:00:00 +01:00
parent 003a28cf1b
commit 6ec0d83c0b
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,3 +1,22 @@
## Play
Download the release for your platform, see [Releases](https://github.com/epic-64/binbreak/releases).
There is one file for linux and one for windows (.exe).
## Linux
- download the file `binbreak-linux`
- open a terminal and navigate to the folder where you downloaded it, e.g. `cd ~/Downloads`
- make it executable: `chmod +x binbreak-linux`
- run the game: `./binbreak-linux`
Instead of relying on prebuilt binaries, you can also build from source.
## Build/Run from source
- download the source code
- make sure you have Rust and Cargo installed, see [rustup.rs](https://rustup.rs/)
- open a terminal and navigate to the folder where you downloaded the source code, e.g. `cd ~/Downloads/binbreak`
- build the project: `cargo build --release`
## Run
```bash
cargo run --release