jasterv/teatui
1
0
Fork 0
mirror of https://codeberg.org/JasterV/teatui.git synced 2026-04-26 18:10:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
JasterV 2025-08-19 22:47:53 +02:00
parent 520afe7183
commit ec36094fee
1 changed files with 38 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -1,6 +1,6 @@
# Ratatui Elm
This is an experimental project that aims to build an Elm-like framework for TUI development in Rust.
This is an experimental project that aims to build an Elm-like framework for TUI development in Rust on top of [Ratatui](https://github.com/ratatui/ratatui).
My main motivation to build this was to understand if I could structure a [Ratatui](https://github.com/ratatui/ratatui) application in an Elm-like fashion.
@ -10,9 +10,44 @@ I want to minimize the usage of mutability and build the most pure functional TU
I feel that Elm has always been a great example to follow when it comes to building frontend in a pure-functional style, and so I will try to reproduce it in here.
## License
Copyright (c) JasterV <49537445+JasterV@users.noreply.github.com>
## How does it work
The state of your application is represented by a single type called the Model.
The Model will be used by a `view` process to render a View.
A separate process will read events from the outside world and
send them to an `update` process.
The `update` process will take the model and an event and
return a new model, potentially also returning a side effect.
The updated model will be sent to the `view`, triggering a new render
based on the new state of the application.
If any side effects are returned from `update`, they will be processed
in a separate process.
If the process responsible for handling side effects wants to update
the state of the application, it will send a message to the `update` process.
The users of this framework only need to provide:
- An update function that given a model and a message return an `Update` instance.
- A view function that given a reference to the model, returns a `View`
- An effects function that given a reference to the model and an effect,
might perform any side effects and optionally return a message to update the state of the application
### Examples
You can find a folder with example projects in the [examples](https://github.com/JasterV/ratatui-elm/tree/main/examples) folder.
## License
This project is licensed under the MIT license ([LICENSE] or <http://opensource.org/licenses/MIT>)