Instructions to setup & run R3BL TUI engine

readme.md

I have built the "TUI engine" & hosted it on github & published it to crates.io. Feel free to check them out here:

• github: https://github.com/r3bl-org/r3bl_rs_utils
• crates.io: https://crates.io/crates/r3bl_rs_utils/

The R3BL CMDR product, and R3BL BASE product have not been built. I am securing funding in order to be able to build them :). Here are some instructions on how you can run the demo on your own machine (macOS, Windows, or Linux).

1. Install Rust toolchain

The first thing is installing Rust toolchain on your computer. Here are the instructions that you can follow to do this: https://www.rust-lang.org/tools/install

2. Install and run R3BL TUI engine demo

mkdir demo
cd demo
git clone https://github.com/r3bl-org/r3bl_rs_utils
# This following folder is where all the demo source code can be found.
cd r3bl_rs_utils/tui/examples 
cargo run --release --example demo

You can play w/ the demo and it looks like this: https://user-images.githubusercontent.com/2966499/206881196-37cf1220-8c1b-460e-a2cb-7e06d22d6a02.mp4

Documentation links

To understand what is going on here are some links:

1. Overview of how all this works: https://github.com/r3bl-org/r3bl_rs_utils/tree/main/tui#text-user-interface-engine-for-rust
2. Source docs: https://docs.rs/r3bl_tui/0.2.0/r3bl_tui/
3. Here are all the issues that are closed & open: https://github.com/r3bl-org/r3bl_rs_utils/issues