From 47d722261c00f91c74f4ee58b21feea6d8245e4e Mon Sep 17 00:00:00 2001 From: arthur-cw Date: Mon, 4 Jul 2022 01:49:39 -0300 Subject: [PATCH] docs: improve installation steps --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 20 +++++++++----------- 3 files changed, 11 insertions(+), 13 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 2613581..5afdd1d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -183,7 +183,7 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" [[package]] name = "chaintrak" -version = "0.1.0" +version = "0.1.1" dependencies = [ "anyhow", "clap", diff --git a/Cargo.toml b/Cargo.toml index c5b0563..afbd274 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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 diff --git a/README.md b/README.md index 332a2c1..6a2e0ec 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ ## 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 🎷 @@ -10,12 +10,10 @@ just pick one: ### 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: @@ -24,19 +22,19 @@ sudo apt update && sudo apt install -y libasound2-dev pkg-config ``` - install the Rust toolchain -- run `cargo build --release --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