~quf/cleave

174ad7d46217ab1b89b29c34a762b56139ce72b8 — Lukas Himbert 11 months ago 9aefb1e
README (again)
1 files changed, 15 insertions(+), 3 deletions(-)

M README.md
M README.md => README.md +15 -3
@@ 100,10 100,17 @@ If you need any of these features then please look elsewhere, fork this project,

## How to install/run

Download and build the software:

```
$ git clone https://git.sr.ht/~quf/cleave
$ cd cleave
$ cargo build --release
```

Initialize a run database for a new game/category:

```
$ cat > segments.txt << EOF
Prologue
  Prologue


@@ 118,9 125,14 @@ Chapter 3
  Prepare for the end
  The end
EOF
$ cargo run --release init-db --title "Emberforce 3" --category "any% no WW" --splitlist segments.txt times.db
$ sqlite3 times.db < util/config.sql # configure colors, keybindings, etc.
$ cargo run --release run times.db # start the timer program
$ cargo run --release init --title "Emberforce 3" --category "any% no WW" --splitlist segments.txt times.db
$ sqlite3 times.db < util/config.sql # configure fonts, keybindings, etc. make sure to edit this to your needs!
```

Run the timer:

```
$ cargo run --release run times.db
```

`sqlite3` (version 3.37+) and SDL2 (including SDL2-ttf) needs to be installed.