File tree Expand file tree Collapse file tree 1 file changed +17
-2
lines changed
Expand file tree Collapse file tree 1 file changed +17
-2
lines changed Original file line number Diff line number Diff line change @@ -11,15 +11,30 @@ The client is designed to be modular and easily extensible for additional functi
1111![ Architecture Diagram] ( https://res.cloudinary.com/dev-connect/image/upload/v1675235495/diet-client-v0-arch_bhdd4c.png )
1212
1313## Getting started
14+ ** Install Rust**
15+ MacOS & Linux
16+ ```
17+ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
18+ ```
19+ Note: For Windows download rustup from this [ link] ( https://forge.rust-lang.org/infra/other-installation-methods.html#other-ways-to-install-rustup )
1420
15- Build and add to path
21+ ** Configure Toolchain**
22+ ```
23+ rustup default nightly
24+ ```
25+
26+ ** Build and Add to Path**
1627```
1728cargo b -r && cp ./target/release/tinydancer ~/.local/bin/
1829```
19- Or install using cargo
30+ ** Or Install Using Cargo **
2031```
2132cargo install --git https://github.com/tinydancer-io/half-baked-client tinydancer
2233```
34+ ** Confirm Installation**
35+ ```
36+ tinydancer --help
37+ ```
2338## Testing
2439Testing is mostly manual, in the future we will implement unit tests
2540but for now we have bash scripts in the ` scripts ` folder.
You can’t perform that action at this time.
0 commit comments