From fcbfcdff737fc65df127c81d7a9bdd5ce56f8b49 Mon Sep 17 00:00:00 2001 From: Jakub Stachurski Date: Thu, 14 Aug 2025 23:58:00 +0200 Subject: [PATCH] Add README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d33e0ba --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Ratatui demo. +A more universal way to draw ratatui applications, made for creating [demo's](https://en.wikipedia.org/wiki/Demoscene). + +I created this so people could add demo's to the ssh signon service for SNT. +For more details see [this repo](https://gitlab.snt.utwente.nl/jakub/memadd). + +# How to use. +Later, I might figure out the cargo template thing, but this would also imply making a library for the trait, which I am too lazy to do right now. + +For now the way you can use it is to clone the repo and start writing your demo in [`app.rs`](./src/app.rs). +If you need to know what each trait method does you can look it up in [`main.rs`](./src/main.rs). + +To run your demo, just type: `cargo run` + +# How to share. +Since right now the whole demo is self-contained, you can just share the links to your repo. +If the person you are sharing with has the same OS and CPU, you can also send the executable in `target/debug/ratatui-demo`, since rust is statically linked. + +