docs: update build instructions

Merrit · Jan 31, 2023 · 4861b61 · 4861b61
1 parent 7570e8e
commit 4861b61
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 48 deletions.
diff --git a/BUILDING.md b/BUILDING.md
@@ -0,0 +1,36 @@
+# Building Nyrna
+
+
+## Requirements
+
+1. Requires a working instance of [Flutter](https://docs.flutter.dev/get-started/install).
+
+2. Requires `libappindicator` and `keybinder`.
+
+    Fedora:
+
+    ```
+    sudo dnf install libappindicator-gtk3 libappindicator-gtk3-devel keybinder keybinder3 keybinder3-devel
+    ```
+
+    Ubuntu:
+
+    ```
+    sudo apt-get install appindicator3-0.1 libappindicator3-dev keybinder-3.0
+    ```
+
+
+## Build
+
+Run these commands from the root directory of the repo:
+
+1. `flutter clean`
+2. `flutter pub get`
+3. `flutter build linux` or `flutter build windows`
+
+
+Compiled app location:
+
+Linux: `build/linux/x64/release/bundle`
+
+Windows: `build\windows\runner\Release`
diff --git a/COMPILING.MD b/COMPILING.MD
diff --git a/README.md b/README.md
@@ -65,6 +65,6 @@ View install options on the [website](https://nyrna.merritt.codes/download).
 Unfortunately no. [CRIU](https://criu.org/) looks very promising to allow us to do this (on Linux), however it [does not currently support suspending GUI applications](https://criu.org/X_applications).
 
 
-## Compiling
+## Building
 
-See [COMPILING](COMPILING.MD)
+See [BUILDING](BUILDING.md)