From 8c15729ada40e9a5e1674cc729dee58dde9a8e71 Mon Sep 17 00:00:00 2001
From: Niko PLP <niko@nextgraph.org>
Date: Mon, 21 Aug 2023 17:42:25 +0300
Subject: [PATCH] updated READMEs

---
 README.md        | 31 ++++++++++++++++++++++++++++---
 ng-app/README.md | 29 ++++++++++++++++-------------
 ngd/README.md    |  7 +++++++
 3 files changed, 51 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index fc41bbb..9fa0af6 100644
--- a/README.md
+++ b/README.md
@@ -63,7 +63,7 @@ The crates are organized as follow :
 
 ### Run
 
-Build & run executables:
+Build & run debug executables:
 
 ```
 // runs the daemon
@@ -110,11 +110,24 @@ cargo test --package p2p-client-ws --lib -- remote_ws::test::test_ws --nocapture
 
 ### Build release binaries
 
-First you will need to build the single-file release of ng-app.
+First you will need to have the production build of the frontend.
+If you do not want to setup a whole development environment for the frontend, you can use the precompiled release of the frontend available in `dist-file.tar.gz`
 
 ```
-// uncomment line 14 of src/App.svelte: import * as api from "ng-sdk-js";
 cd ng-app
+tar -xzf dist-file.tar.gz
+cd ..
+```
+
+Otherwise, build from source the single-file release of ng-app
+
+```
+npm install -g pnpm
+cd ng-sdk-js
+wasm-pack build --target bundler
+// uncomment line 14 of ng-app/src/App.svelte: import * as api from "ng-sdk-js";
+cd ../ng-app
+pnpm install
 pnpm webfilebuild
 cd ..
 ```
@@ -127,6 +140,18 @@ cargo build -r -p ngd
 
 you can then find the binary `ngd` in `target/release`
 
+The CLI tool can be obtained with :
+
+```
+cargo build -r -p ngcli
+```
+
+you can then use the binary `target/release/ngd`
+
+For usage, see the documentation [here](ngd/README.md).
+
+For building the apps, see this [documentation](ng-app/README.md).
+
 ### Generate documentation
 
 Generate documentation for all packages without their dependencies:
diff --git a/ng-app/README.md b/ng-app/README.md
index 46171b5..824873a 100644
--- a/ng-app/README.md
+++ b/ng-app/README.md
@@ -2,20 +2,11 @@
 
 NextGraph native apps use the Tauri framework.
 
-All the apps are using an embedded WebView that renders a Svelte app.
+All the native apps are using an embedded WebView that renders a Svelte app.
 
 ## Install
 
-prerequisites: compile the local SDK
-
-```
-cd ../ng-sdk-js
-wasm-pack build --target bundler
-cd ../ng-app
 ```
-
-```
-cargo install tauri-cli --version "=2.0.0-alpha.10" --locked
 npm install -g pnpm
 pnpm install
 ```
@@ -26,6 +17,14 @@ pnpm install
 
 ## Web
 
+prerequisites: compile the local SDK
+
+```
+cd ../ng-sdk-js
+wasm-pack build --target bundler
+cd ../ng-app
+```
+
 #### Dev
 
 ```
@@ -53,6 +52,10 @@ pnpm webfilebuild
 
 ## Desktop
 
+```
+cargo install tauri-cli --version "=2.0.0-alpha.10" --locked
+```
+
 Install [all prerequisites](https://next--tauri.netlify.app/next/guides/getting-started/prerequisites/) for your dev platform.
 
 to run the dev env :
@@ -82,13 +85,13 @@ cargo tauri build
 cargo tauri build --target x86_64-unknown-linux-gnu
 ```
 
-### Windows (7)
+### Windows (7+)
 
 ```
 cargo tauri build --target x86_64-pc-windows-msvc
 ```
 
-## Android
+### Android
 
 - [Install Android Studio](https://developer.android.com/studio)
 
@@ -123,7 +126,7 @@ to debug the Svelte app, use Chrome :
 - [chrome://inspect/#devices](chrome://inspect/#devices)
 - install the [svelte extension](https://chrome.google.com/webstore/detail/svelte-devtools/ckolcbmkjpjmangdbmnkpjigpkddpogn)
 
-## iOS
+### iOS
 
 First, make sure Xcode is properly installed. then :
 
diff --git a/ngd/README.md b/ngd/README.md
index c00b5e1..190c90d 100644
--- a/ngd/README.md
+++ b/ngd/README.md
@@ -1,9 +1,16 @@
 # ngd - NextGraph Daemon
 
+## Building
+
+See [Build release binaries](../README.md#build-release-binaries) in the main page.
+
 ## Usage
 
 ### Create the first admin user
 
+The current directory will be used to save all the config, keys and storage data.
+If you prefer to change the base directory, use the argument `--base [PATH]` when using `ngd` and/or `ngcli`.
+
 ```
 ngcli gen-key
 ngd --save-key -d <DOMAIN_NAME> -l 1440 --admin <THE_USER_ID_YOU_JUST_CREATED>