Sorted out the documentation

This commit is contained in:
Mikal Villa 2015-09-10 02:09:56 +08:00
parent 07adb8ff64
commit 01c11d5fa5
8 changed files with 166 additions and 3 deletions

30
doc/BUILDING.md Normal file
View file

@ -0,0 +1,30 @@
Building
========
On Ubuntu/Debian based
* sudo apt-get install libboost-dev libboost-filesystem-dev libboost-program-options-dev libboost-regex-dev libcrypto++-dev libboost-date-time-dev
* $ cd i2pd/build
* $ cmake ..
* $ make
Then, run it:
$ ./i2pd
The client should now reseed by itself.
By default, the web console is located at http://localhost:7070/.
For a list of cmake options, see build/BUILD_NOTES.md
Building Unit Tests
===================
To build unit tests, you'll need to install the boost unit test framework.
On Ubuntu/Debian based
* sudo apt-get install libboost-test-dev
To build the tests, run
$ cmake .. -DWITH_TESTS=ON