Initial

Signed-off-by: Ivan Kuznetsov <[email protected]>

README.md

@@ -2,7 +2,82 @@
 * Operating System for Flight and Mission Operations devices
 * A ghaf-based operating system designed specifically for FMO devices
 * Currently support: Dell Latitude 7230 Rugged Extreme Tablet & Dell Latitude 7330 Rugged Extreme Laptop
-## Release note
+
+# Table of Contents
+1. [How to compile](#how-to-compile)
+1. [Using cachix to build speed up](#using-cachix-to-build-speed-up)
+1. [Ghaf documentation links](#ghaf-documentation-links)
+1. [Release notes](#release-notes)
+
+# How to compile
+- Clone the project:
+  ```bash
+  $ git clone https://github.com/tiiuae/FMO-OS.git
+  ```
+- Move to source folder
+  ```bash
+  $ cd FMO-OS
+  ```
+- Install NIX (you also can make it manually or use NIX-OS, then you may skip this part):
+  ```bash
+  $ bash .github/actions/build-action/install_nix.sh
+  ...
+  ...
+  [ 1 ]
+  Nix won't work in active shell sessions until you restart them.
+  ```
+- No you need to restart your session:
+```bash
+$ exit
+```
+- Reloging your session and go to the source folder again:
+```bash
+$ cd FMO-OS
+```
+- Check build targets:
+```bash
+$ nix flake show
+...
+...
+└───packages
+    └───x86_64-linux
+        ├───fmo-os-installer-debug: package 'nixos.iso'
+        ├───fmo-os-installer-debug-compressed: package 'nixos.iso'
+        ├───fmo-os-installer-public-debug: package 'nixos.iso'
+        ├───fmo-os-installer-public-debug-compressed: package 'nixos.iso'
+        ├───fmo-os-installer-public-release: package 'nixos.iso'
+        ├───fmo-os-installer-public-release-compressed: package 'nixos.iso'
+        ├───fmo-os-installer-release: package 'nixos.iso'
+        ├───fmo-os-installer-release-compressed: package 'nixos.iso'
+
+```
+- Build FMO-OS installer image (you need to have github ssh keys installed on your system):
+```bash
+$ nix build -L .#fmo-os-installer-debug
+```
+
+# Using cachix to build speed up
+- You may use binary $ to speed up your builds
+- Install cachix:
+```bash
+$ nix-env -iA cachix -f https://cachix.org/api/v1/install
+```
+- Authenticate:
+```bash
+$ cachix authtoken {put_your_token here}
+```
+- Use $ix to build:
+```bash
+$ cachix use fmo-os
+$ nix build -L .#fmo-os-installer-debug
+```
+
+
+# Ghaf documentation links
+
+The Ghaf Framework documentation site is located at [link](https://tiiuae.github.io/ghaf/)
+
+# Release notes
 v1.1.0a
 * oras: /fmo/pmc-installer:v1.1.0a
 ```