vyn/mirai
1
Fork 0
mirror of https://codeberg.org/vyn/mirai.git synced 2025-07-02 01:13:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README with build && download instructions

Browse source
This commit is contained in:
Vyn 2024-05-24 17:26:22 +02:00
parent 6cf752a83d
commit 437ea16d7c
1 changed files with 23 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -13,16 +13,37 @@ with whatever you want and sync them using third party software (like Syncthing)
## Download
### Linux
You can download Mirai from the [releases page](https://codeberg.org/vyn/mirai/releases).
### Android
Currently only `Linux (x86_64)` is officially supported.
## Build from source
### Requirements
- Qt >= 6.7.0
- GCC >= 14.1.1
- CMake >= 3.29.3
- Ninja (or Make but you will need to adapt the commands)
- Git
### Steps
Fetch and setup the repository:
```
git clone https://codeberg.org/vyn/mirai.git
cd mirai
git submodule update --init --recursive
```
To build:
```
cmake -DCMAKE_BUILD_TYPE=Release -S . -B ./build -G Ninja
cd build
ninja
```
Then you should have a `mirai` executable in the `build` directory you are currently in.
## License
Copyright (C) Vyn 2024