From c2f344ae4014ff8a0594345579757c49cce62507 Mon Sep 17 00:00:00 2001 From: Darknet Villain Date: Mon, 30 Jan 2017 08:32:22 -0500 Subject: [PATCH] Added requirements page --- docs/devs/building/requirements.md | 15 +++++++++++++++ docs/user-guide/install.md | 2 +- mkdocs.yml | 2 +- 3 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 docs/devs/building/requirements.md diff --git a/docs/devs/building/requirements.md b/docs/devs/building/requirements.md new file mode 100644 index 0000000..1bb163e --- /dev/null +++ b/docs/devs/building/requirements.md @@ -0,0 +1,15 @@ +Build requirements +================== + +In general, for building i2pd you need several things: + +* compiler with c++11 support (for example: gcc >= 4.7, clang) +* boost >= 1.49 +* openssl library +* zlib library (openssl already depends on it) + +Optional tools: + +* cmake >= 2.8 (or 3.3+ if you want to use precompiled headers on windows) +* miniupnp library (for upnp support) +* [websocketpp](https://github.com/zaphoyd/websocketpp/) (for websocket ui) diff --git a/docs/user-guide/install.md b/docs/user-guide/install.md index 7500de6..6787265 100644 --- a/docs/user-guide/install.md +++ b/docs/user-guide/install.md @@ -4,7 +4,7 @@ Installing Building from source -------------------- -See developer section documentation for how to build i2pd from source on your OS. +See [developer section documentation](../devs/building/requirements.md) for how to build i2pd from source on your OS. Windows, Android, Mac OS X diff --git a/mkdocs.yml b/mkdocs.yml index 34a7485..a6ef59f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,7 +22,7 @@ pages: - Filesharing: tutorials/filesharing.md - Using RetroShare with i2pd: tutorials/retroshare.md - Developer Section: - - Building from source: + - Building from source: devs/building/requirements.md - Unix: devs/building/unix.md - Windows: devs/building/windows.md - Android: devs/building/android.md