Julian/Gitnuro
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated DEVELOPMENT.MD to reflect the need of Rust/Cargo to build Gitnuro

Browse Source
This commit is contained in:
Abdelilah El Aissaoui 2023-08-04 00:33:18 +02:00
parent e541c60fc2
commit 594e41eda2
No known key found for this signature in database
GPG Key ID: 7587FC860F594869
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
DEVELOPMENT.md
View File

@ -9,13 +9,19 @@ such that it's available on the `$PATH`. See [here](https://www.libssh.org/get-i
instructions with your OS's package manager, or manually download a binary or compile it from source and place it in the instructions with your OS's package manager, or manually download a binary or compile it from source and place it in the
main project directory (next to `LICENSE`) or elsewhere on your `$PATH`. main project directory (next to `LICENSE`) or elsewhere on your `$PATH`.
## Setting up Rust
Gitnuro is mainly written in Kotlin (JVM) but also uses Rust for some specific tasks. To set up your Rust environment,
please read [its documentation](https://www.rust-lang.org/). `Cargo` and `rustc` must be available in the path in order to build Gitnuro properly.
## Setting up an IDE ## Setting up an IDE
If you don't have another preference, the recommendation is to download and install If you don't have another preference, the recommendation is to download and install
[IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/)
(possibly through the JetBrains Toolbox, if you have it already) as well as the (possibly through the JetBrains Toolbox, if you have it already). The recommended plugins to improve the DX are:
[Compose Multiplatform IDE Support](https://plugins.jetbrains.com/plugin/16541-compose-multiplatform-ide-support)
plugin. - [Compose Multiplatform IDE Support](https://plugins.jetbrains.com/plugin/16541-compose-multiplatform-ide-support)
- [Rust Plugin](https://plugins.jetbrains.com/plugin/8182-rust)
By default, the JDK used by "IntelliJ IDEA Community Edition (2023.1.3)" is "JetBrains Runtime version 21" which is not currently supported by the project. By default, the JDK used by "IntelliJ IDEA Community Edition (2023.1.3)" is "JetBrains Runtime version 21" which is not currently supported by the project.