Skip to content

Commit

Permalink
docs: improve installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
arthur-cw committed Jul 4, 2022
1 parent dfe9216 commit e20c183
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
## chaintrak

events from our currently most important contracts on [CloudWalk Mainnet](https://explorer.mainnet.cloudwalk.io/) are mapped into one-shot samples to produce vibes.
events from `BRLC`, `PixCashier`, `SpinMachine` and `CErc20Delegate` contracts on [CloudWalk Mainnet](https://explorer.mainnet.cloudwalk.io/) are mapped into one-shot samples to produce vibes

just pick one:
pick one:

> jazz 🎷
> ambient 😶‍🌫️

### install
you can either download the binary or build it from source yourself
you can either [download the binary](https://github.com/arthur-cw/chaintrak/releases) or build it from source yourself

##### build from source
- install dependencies. the main one is ALSA, check the name of the libs for your OS.

no support for Windows sorry.
- install dependencies. the main one is ALSA, check the name of the libs for your OS. no support for Windows now, sorry.

on GNU/Linux Ubuntu, for example, run:

Expand All @@ -24,7 +22,7 @@ sudo apt update && sudo apt install -y libasound2-dev pkg-config
```

- install the Rust toolchain
- run `cargo build --release --path <PATH>` and choose where to install the binary.
- run `cargo build --release --path <PATH>` and choose a path to install the binary.

##### listen
- start the application by picking your current vibe:
Expand Down

0 comments on commit e20c183

Please sign in to comment.