lokinet/readme.md

56 lines
1.1 KiB
Markdown
Raw Normal View History

2018-01-25 15:38:14 +00:00
# LLARP
2018-01-25 15:38:14 +00:00
Low Latency Anon Routing Protocol
2018-05-20 12:49:38 +00:00
We'll be ready when we're ready.
2018-04-05 14:52:35 +00:00
2018-06-01 18:23:01 +00:00
[who](https://github.com/majestrate)
[what + why](doc/high-level.txt)
[when](http://i0.kym-cdn.com/photos/images/original/000/117/021/enhanced-buzz-28895-1301694293-0.jpg)
[where](https://joedaeskimo.files.wordpress.com/2011/01/idklol.jpg)
2018-05-16 13:59:40 +00:00
[how](doc/proto_v0.txt)
2017-10-03 19:14:46 +00:00
2018-06-01 18:23:01 +00:00
## Building
You have 2 ways the build this project
### The recommended way (for stable builds)
$ git clone --recursive https://github.com/majestrate/llarpd-builder
$ cd llarpd-builder
$ make
### The "I want to risk ripping my fingernails off in frustration" way (for dev builds)
2017-10-03 19:14:46 +00:00
Build requirements:
2018-06-01 18:23:01 +00:00
* CMake
* ninja
2017-10-03 19:14:46 +00:00
* libsodium >= 1.0.14
* c++ 17 capable C++ compiler
2018-05-16 14:00:08 +00:00
* c11 capable C compiler
2018-01-25 16:11:45 +00:00
2018-06-01 18:23:01 +00:00
Building a debug build:
2018-01-25 16:11:45 +00:00
$ make
2018-06-01 18:23:01 +00:00
2018-06-01 18:23:01 +00:00
## Running
2018-06-01 18:23:01 +00:00
Right now the reference daemon connects to nodes you tell it to and that's it.
If you built using the `recommended` way just run:
2018-05-16 15:52:05 +00:00
2018-06-01 18:23:01 +00:00
$ ./llarpd
2018-05-16 15:52:05 +00:00
2018-06-01 18:23:01 +00:00
It'll attempt to connect to a test node I run and keep the session alive.
That's it.
2018-01-25 16:11:45 +00:00
2018-06-01 18:23:01 +00:00
If you built using the dev build you are expected to configure the daemon yourself.