Update README.md

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

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,
utilizing the capabilities of the
[Rinf](https://pub.dev/packages/rinf) framework.
```bash
cargo install rinf
```
To run and build this app, you need to have
[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.
And check if all the requirement are installed successfully :
```bash
rustc --version
flutter doctor
```
You also need to have the CLI tool for Rinf ready.
## Compile
```bash
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:
First generate all the necessary messages :
```bash
rinf message
```
Now you can run and build this app just like any other Flutter projects.
Then compile the project :
```bash
flutter run
```
For detailed instructions on writing Rust and Flutter together,
please refer to Rinf's [documentation](https://rinf.cunarist.com).