Alez/Babylonia-terminal
1
0
Fork 0
mirror of https://github.com/ALEZ-DEV/Babylonia-terminal.git synced 2026-03-21 21:58:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
ALEZ 2024-06-11 07:19:50 +02:00 committed by GitHub
parent 787b1ea216
commit a1cc3fc43f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
babylonia_terminal_launcher/README.md
View File

@ -1,44 +1,32 @@
# How to compile the GUI version
## Requirement
## Using Rust Inside Flutter You need the [base](https://github.com/ALEZ-DEV/Babylonia-terminal?tab=readme-ov-file#requirement) requirement
You will need [Flutter](https://flutter.dev/) in order to compile the GUI version
Install [Rinf](https://github.com/cunarist/rinf) with **Cargo** :
This project leverages Flutter for GUI and Rust for the backend logic, ```bash
utilizing the capabilities of the cargo install rinf
[Rinf](https://pub.dev/packages/rinf) framework. ```
To run and build this app, you need to have And check if all the requirement are installed successfully :
[Flutter SDK](https://docs.flutter.dev/get-started/install)
and [Rust toolchain](https://www.rust-lang.org/tools/install)
installed on your system.
You can check that your system is ready with the commands below.
Note that all the Flutter subcomponents should be installed.
```bash ```bash
rustc --version rustc --version
flutter doctor flutter doctor
``` ```
You also need to have the CLI tool for Rinf ready. ## Compile
```bash First generate all the necessary messages :
cargo install rinf
```
Messages sent between Dart and Rust are implemented using Protobuf.
If you have newly cloned the project repository
or made changes to the `.proto` files in the `./messages` directory,
run the following command:
```bash ```bash
rinf message rinf message
``` ```
Now you can run and build this app just like any other Flutter projects. Then compile the project :
```bash ```bash
flutter run flutter run
``` ```
For detailed instructions on writing Rust and Flutter together,
please refer to Rinf's [documentation](https://rinf.cunarist.com).