From 62330e91a8e63fe8f7d31086ec78987982a05ebe Mon Sep 17 00:00:00 2001 From: David Date: Sun, 30 Jun 2024 14:05:37 +0300 Subject: [PATCH] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 47630876..29b8f256 100644 --- a/README.md +++ b/README.md @@ -49,24 +49,24 @@ Recommended cmake version 3.26 Minimum erlang version otp 25 (Tested 24,25,26) Minimum gcc/g++ version 10.3.0 -On every device that is a part of Nerlnet cluster the following steps should be taken: +### On every device that hosts Nerlnet cluster entities, do the following steps: 1. Clone this repository with its subomdules ```git clone --recurse-submodules NErlNet``` 2. Run ```sudo ./NerlnetInstall.sh``` - 2.1 With argument -i script builds and installs Erlang, latest stable, and CMake. - (validate that erlang is not installed before executing installation from source) + 2.1 With argument -i script builds and installs Erlang (OTP 25), and CMake from source. + (validate that erlang is not installed before executing installation from source) 2.2 On successful installation, NErlNet directory is accessible     via the following path: ```/usr/local/lib/nerlnet-lib``` 3. Run ```./NerlnetBuild.sh``` 4. Test Nerlnet by running: ```./tests/NerlnetFullFlowTest.sh``` -5. [Nerlplanner](https://github.com/leondavi/NErlNet/tree/master/src_py/nerlPlanner) is a Nerlnet tool to generate required jsons files to setup a distributed system of Nerlnet. -To use NerlPlanner execute ```./NerlPlanner.sh``` (support starts from version 1.3.0). +5. [Nerlplanner](https://github.com/leondavi/NErlNet/wiki/NerlPlanner) is a Nerlnet tool to generate required jsons files to setup a distributed system of Nerlnet. +To use NerlPlanner execute ```./NerlPlanner.sh```. Create json files of distributed configurations, connection map and experiment flow as follows: - dc_\.json - conn_\.json - exp_\.json -6. Run ```./NerlnetRun.sh``` to start Nerlnet. -7. Start Jupyter NB with ```./NerlnetJupyterLaunch.sh``` and follow ApiServerInstance.help() and [examples](https://github.com/leondavi/NErlNet/tree/master/examples). +6. Run ```./NerlnetRun.sh```. +7. On API-Server device, Start Jupyter NB with ```./NerlnetJupyterLaunch.sh``` and follow ApiServerInstance.help() and [examples](https://github.com/leondavi/NErlNet/tree/master/examples). ## Python API and Jupyter-lab (For Api-Server): Minimum Python version: 3.8