Skip to content

Commit

Permalink
Update video links across all README files for v0.3.3
Browse files Browse the repository at this point in the history
Update tui/README.md as well for getting started content

Fixes #82
  • Loading branch information
nazmulidris committed Apr 20, 2023
1 parent 192ce2d commit 8cbb12d
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ For more information please read the README for the

Here's a video of the demo in action:

https://user-images.githubusercontent.com/2966499/223200857-33c346fe-ed66-4216-8fb5-2f8c602d5b7c.mp4
https://user-images.githubusercontent.com/2966499/233481838-b6da884f-f73d-4e1f-adef-94beb9761c46.mp4


## redux
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Once captured you can upload to the following sites:
- Edit an the main [README.md](https://github.com/r3bl-org/r3bl_rs_utils#readme) file and drag and
drop the MP4 file from your desktop to the editor. This will upload the video to github.com and
generate a URL like this:
<https://user-images.githubusercontent.com/2966499/223200857-33c346fe-ed66-4216-8fb5-2f8c602d5b7c.mp4>.
<https://user-images.githubusercontent.com/2966499/233481838-b6da884f-f73d-4e1f-adef-94beb9761c46.mp4>.
Make sure to commit the file.
- More info on how to upload video: <https://stackoverflow.com/a/68269430/2085356>

Expand All @@ -43,7 +43,7 @@ Once captured you can upload to the following sites:

- List of all videos
- [v0.2.0](https://user-images.githubusercontent.com/2966499/206881196-37cf1220-8c1b-460e-a2cb-7e06d22d6a02.mp4)
- [v0.3.2](https://user-images.githubusercontent.com/2966499/223200857-33c346fe-ed66-4216-8fb5-2f8c602d5b7c.mp4)
- [v0.3.2](https://user-images.githubusercontent.com/2966499/233481838-b6da884f-f73d-4e1f-adef-94beb9761c46.mp4)

## README and lib.rs updates

Expand Down
38 changes: 26 additions & 12 deletions tui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,18 +138,30 @@ Here are some framework highlights:

Here's a video of the demo in action:

https://user-images.githubusercontent.com/2966499/223200857-33c346fe-ed66-4216-8fb5-2f8c602d5b7c.mp4

1. You can run `cargo run --example demo` in the `tui/examples` folder to see a demo of the library
in action and play with it. The examples cover the entire surface area of the TUI API. You can
also take a look at the tests in the source as well `tui/src/`.

2. This document is a good place to start to get a feel for the architecture of the framework. You
can get a mental model of how everything fits and what the TUI lifecycle is.
https://user-images.githubusercontent.com/2966499/233481838-b6da884f-f73d-4e1f-adef-94beb9761c46.mp4

1. Once you've cloned [the repo](https://github.com/r3bl-org/r3bl_rs_utils) to a folder on your
computer, you can run the examples you see in the video with the following commands:
```sh
cd tui/examples
cargo run --release --example demo
```
These examples cover the entire surface area of the TUI API. You can also take a look at the
tests in the source as well `tui/src/`. A lot of `fish` scripts are provided at the top level
directory of the repo which allow you to easily:
- run tests (`test.fish`)
- build the code (`build.fish`)
- run the logger to see log output (`log.fish`)
- run the examples (`run.fish`).

2. This document that you're reading is a good place to start to get a feel for the architecture of
the framework. You can get a mental model of how everything fits and what the TUI lifecycle is.

3. Additionally the [r3bl_rs_utils_core](https://crates.io/crates/r3bl_rs_utils_core) has the
`tui_core` module which contains dependencies that are used by the `tui` module. They include:
1. ANSI text support.
1. Color support that is [terminal emulator
dependent](https://docs.rs/concolor-query/latest/concolor_query/#) ranging from truecolor, to
[ANSI256](https://www.ditig.com/256-colors-cheat-sheet), to grayscale.
2. Core dimensions and units that are used for positioning and sizing.
3. Grapheme cluster segment and unicode support (emoji support).
4. Lolcat support.
Expand All @@ -159,10 +171,12 @@ https://user-images.githubusercontent.com/2966499/223200857-33c346fe-ed66-4216-8
> `fish` script files. Here are a few worth mentioning here which are related to running the
> example.
>
> 1. `run.fish`: This will simply run the examples. You can watch the logs by running `log.fish`.
> 2. `run-with-flamegraph-profiling.fish`: This will run the examples and generate a flamegraph at
> 1. `run-release.fish`: This will simply run the examples w/ the release build (so it will be
> fast). You can watch the logs by running `log.fish`.
> 2. `run.fish`: This will simply run the examples. You can watch the logs by running `log.fish`.
> 3. `run-with-flamegraph-profiling.fish`: This will run the examples and generate a flamegraph at
> the end so you can see profile the performance of the app.
> 3. `run-with-crash-reporting.fish`: This will run the examples and generate a `crash_log.txt` file
> 4. `run-with-crash-reporting.fish`: This will run the examples and generate a `crash_log.txt` file
> (in the `tui` folder) in case the app crashes. This is useful for debugging.
## How does layout, rendering, and event handling work in general?
Expand Down
2 changes: 1 addition & 1 deletion tui/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@
//! # Examples to get you started
//!
//! Here's a video of the demo in action:
//! <https://user-images.githubusercontent.com/2966499/223200857-33c346fe-ed66-4216-8fb5-2f8c602d5b7c.mp4>
//! <https://user-images.githubusercontent.com/2966499/233481838-b6da884f-f73d-4e1f-adef-94beb9761c46.mp4>
//!
//! 1. You can run `cargo run --example demo` in the `tui/examples` folder to see a demo of the
//! library in action and play with it. The examples cover the entire surface area of the TUI
Expand Down

0 comments on commit 8cbb12d

Please sign in to comment.