From a34ea1e3a864e02d3275126804b326be243de6f0 Mon Sep 17 00:00:00 2001 From: Jeff Becker Date: Tue, 23 Oct 2018 07:51:11 -0400 Subject: [PATCH] update readme and include bootstrap script --- lokinet-bootstrap | 8 ++++++++ readme.md | 39 ++++++++++----------------------------- 2 files changed, 18 insertions(+), 29 deletions(-) create mode 100755 lokinet-bootstrap diff --git a/lokinet-bootstrap b/lokinet-bootstrap new file mode 100755 index 000000000..e1aed0d2b --- /dev/null +++ b/lokinet-bootstrap @@ -0,0 +1,8 @@ +#!/bin/bash +# +# this shell script will be replaced by a proper program in the future (probably) +# + +if [ "X$1" = "X" ] ; then url="https://i2p.rocks/i2procks.signed" ; else url="$1" ; fi +echo "downloading $url" +wget -O $HOME/.lokinet/bootstrap.signed "$url" &> /dev/null || echo "failed to download bootstrap from $url" diff --git a/readme.md b/readme.md index fda425203..baad1e34b 100644 --- a/readme.md +++ b/readme.md @@ -6,45 +6,26 @@ You can learn more about the high level design of LLARP [here](docs/high-level.t And you can read the LLARP protocol specification [here](docs/proto_v0.txt) -## Building - - $ sudo apt install build-essential libtool autoconf cmake git - $ git clone --recursive https://github.com/loki-project/lokinet-builder - $ cd lokinet-builder - $ make - -## Running - - $ ./lokinet - -### Development +![build status](https://gitlab.com/lokiproject/loki-network/badges/master/pipeline.svg "build status") -Please note development builds are likely to be unstable +## Building Build requirements: * GNU Make * CMake -* libsodium >= 1.0.14 * C++ 17 capable C++ compiler -Building a debug build: - -## Building - -![build status](https://gitlab.com/lokiproject/loki-network/badges/master/pipeline.svg "build status") - -use the [lokinet builder](https://github.com/loki-project/lokinet-builder) repo. + $ sudo apt install build-essential cmake git libcap-dev + $ git clone https://github.com/loki-project/loki-network + $ cd loki-network + $ make -j8 -## Development +## Running -for a development environment: + $ ./lokinet-bootstrap + $ ./lokinet - $ sudo apt install git libcap-dev build-essential ninja-build cmake libsodium-dev - $ git clone https://github.com/loki-project/loki-network - $ cd loki-network - $ make -j $(cat /proc/cpuinfo | grep processors | wc -l) # use all the cores lmao - ## Usage -see the [lokinet-builder](https://github.com/loki-project/lokinet-builder) +see the [documentation](https://loki-project.github.io/loki-docs/Lokinet/LokinetOverview/) on how to get started.