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 47d7222
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "chaintrak"
version = "0.1.0"
version = "0.1.1"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
20 changes: 9 additions & 11 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 and each new block from [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 Windows support for now, sorry.

on GNU/Linux Ubuntu, for example, run:

Expand All @@ -24,19 +22,19 @@ 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`

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

``` sh
chaintrak jazz
chaintrak ambient
./target/release/chaintrak jazz
./target/release/chaintrak ambient
```

#### TODO
- lazy load of samples depending on the vibe
- normalize volumes
- normalize volumes
- improve logs (show contract name)
- add more vibez

#### license
Expand Down

0 comments on commit 47d7222

Please sign in to comment.