diff --git a/readme.md b/readme.md index 2e40cbf80..de4d976a9 100644 --- a/readme.md +++ b/readme.md @@ -18,20 +18,25 @@ See the [documentation](https://loki-project.github.io/loki-docs/Lokinet/Lokinet Also read the [Public Testing Guide](https://lokidocs.com/Lokinet/Guides/PublicTestingGuide/#1-lokinet-installation) for installation and other helpful information. -## Running on Linux - -**DO NOT RUN AS ROOT**, run as normal user. This requires the binary to have the proper setcaps set by `make install` on the binary. +### Create default config -to run as client: +to configure as client: $ lokinet -g $ lokinet-bootstrap - $ lokinet -to run as relay: +to configure as relay: $ lokinet -r -g $ lokinet-bootstrap + + +## Running on Linux + +**DO NOT RUN AS ROOT**, run as normal user. This requires the binary to have the proper setcaps set by `make install` on the binary. + +to run, after you create default config: + $ lokinet ## Running on MacOS/UNIX/BSD @@ -40,19 +45,10 @@ to run as relay: The MacOS installer places the normal binaries (`lokinet` and `lokinet-bootstrap`) in `/usr/local/bin` which should be in your path, so you can easily use the binaries from your terminal. The installer also nukes your previous config and keys and sets up a fresh config and downloads the latest bootstrap seed. -to run as client: +to run, after you create default config: - $ lokinet -g - $ lokinet-bootstrap $ sudo lokinet -to run as relay: - - $ lokinet -r -g - $ lokinet-bootstrap - $ sudo lokinet - - ## Running on Windows **DO NOT RUN AS ELEVATED USER**, run as normal user. @@ -61,17 +57,18 @@ to run as relay: Build requirements: +* Git * CMake * C++ 17 capable C++ compiler -* gcovr (if generating test coverage with gcc) * libuv >= 1.27.0 * libsodium >= 1.0.18 +* gcovr (if generating test coverage with gcc) ### Linux build: - $ sudo apt install build-essential cmake git libcap-dev curl libuv1-dev libsodium-dev libcurl4-openssl-dev pkg-config + $ sudo apt install build-essential cmake git libcap-dev curl libuv1-dev libsodium-dev pkg-config $ git clone --recursive https://github.com/loki-project/loki-network $ cd loki-network $ mkdir build @@ -103,14 +100,8 @@ install: windows builds are cross compiled from ubuntu linux -build requirements: +additional build requirements: -* CMake -* C++ 17 capable C++ compiler -* gcovr (if generating test coverage with gcc) -* libuv >= 1.27.0 -* libsodium >= 1.0.18 -* libcurl * nsis * cpack @@ -140,12 +131,12 @@ build: $ sudo pkg install build-essential gcc8 wget tuntap cmake (optional: ninja ccache - from omnios extra) (OmniOS CE) $ sudo pkg install base-developer-utilities developer-gnu developer-studio-utilities gcc-7 wget cmake (Oracle Solaris, see note) $ sudo pkg install build-essential wget gcc-8 documentation/tuntap header-tun tun (optional: ninja ccache) (all other SunOS) - $ git clone https://github.com/loki-project/loki-network + $ git clone --recursive https://github.com/loki-project/loki-network $ cd loki-network $ mkdir build $ cd build $ cmake .. - $ make -j8 + $ make -j$(nproc) install: @@ -156,7 +147,7 @@ install: build: $ pkg install cmake git curl libuv libsodium pkgconf - $ git clone https://github.com/loki-project/loki-network + $ git clone --recursive https://github.com/loki-project/loki-network $ cd loki-network $ mkdir build $ cmake -DCMAKE_BUILD_TYPE=Release ..