mirror of
https://github.com/oxen-io/lokinet
synced 2023-12-14 06:53:00 +01:00
update readme and include bootstrap script
This commit is contained in:
parent
6828ea2d1f
commit
a34ea1e3a8
8
lokinet-bootstrap
Executable file
8
lokinet-bootstrap
Executable file
|
@ -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"
|
41
readme.md
41
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)
|
||||
|
||||
![build status](https://gitlab.com/lokiproject/loki-network/badges/master/pipeline.svg "build status")
|
||||
|
||||
## 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
|
||||
|
||||
Please note development builds are likely to be unstable
|
||||
|
||||
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.
|
||||
|
||||
## Development
|
||||
|
||||
for a development environment:
|
||||
|
||||
$ sudo apt install git libcap-dev build-essential ninja-build cmake libsodium-dev
|
||||
$ sudo apt install build-essential cmake git libcap-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
|
||||
|
||||
$ make -j8
|
||||
|
||||
## Running
|
||||
|
||||
$ ./lokinet-bootstrap
|
||||
$ ./lokinet
|
||||
|
||||
## 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.
|
||||
|
|
Loading…
Reference in a new issue