update build instructions in README.md

This commit is contained in:
AmirHossein Abdolmotallebi 2024-08-08 13:27:46 +03:30
parent 929e832e58
commit 8f302c1259

View File

@ -96,6 +96,9 @@ fallow these steps.
1. Clone the project
2. Install the [JBR](https://github.com/JetBrains/JetBrainsRuntime/releases)
3. cd into the project, open your terminal and execute the fallowing commands
4. select which way you want to compile the app
<details>
<summary>Packaged (msi,deb at the moment)</summary>
```bash
./gradlew
@ -103,7 +106,35 @@ fallow these steps.
./gradlew packageReleaseDistributionForCurrentOS
```
this will create a package for your **current OS**, so you can compile and install it on your own
This will create an installer package for your **current OS**, so you can install it on your own
>Note: you will get error if your OS does not support any of above package types in this case you should compile it `without packaging`
</details>
<details>
<summary>Without Package</summary>
In case you don't want to package it or your OS does not support those package types you can use this command to compile the app without packaging it
```bash
./gradlew
./gradle createReleaseDistributable
```
It will create an output folder
>NOTE: this is not packaged you may package it yourself manually, or just simply run it!
>I suggest you to move the output somewhere else if you want to run it directly
</details>
The output will be created in
```
<project_dir>/desktop/build/compose/binaries/main-release/app/
```
> **Note**. This project is compiled and published by GitHub actions [here](./.github/workflows/publish.yml), so if you
> faced any problem you can check that too