diff --git a/docs/build_requirements.md b/docs/build_requirements.md deleted file mode 100644 index 3e0dfea9..00000000 --- a/docs/build_requirements.md +++ /dev/null @@ -1,15 +0,0 @@ -Build requirements -============ - -Linux/FreeBSD/OSX ------------------ - -GCC 4.7 or newer, Boost 1.49 or newer, openssl, zlib. Clang can be used instead of GCC. - -Windows -------- - -VS2013 (known to work with 12.0.21005.1 or newer), Boost 1.46 or newer, -crypto++ 5.62. See Win32/README-Build.txt for instructions on how to build i2pd -and its dependencies. - diff --git a/docs/build_notes_android.md b/docs/building/android.md similarity index 100% rename from docs/build_notes_android.md rename to docs/building/android.md diff --git a/docs/build_notes_cross.md b/docs/building/cross.md similarity index 100% rename from docs/build_notes_cross.md rename to docs/building/cross.md diff --git a/docs/build_notes_ios.md b/docs/building/ios.md similarity index 100% rename from docs/build_notes_ios.md rename to docs/building/ios.md diff --git a/docs/building/requirements.md b/docs/building/requirements.md new file mode 100644 index 00000000..8712a03d --- /dev/null +++ b/docs/building/requirements.md @@ -0,0 +1,14 @@ +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) diff --git a/docs/build_notes_unix.md b/docs/building/unix.md similarity index 100% rename from docs/build_notes_unix.md rename to docs/building/unix.md diff --git a/docs/build_notes_windows.md b/docs/building/windows.md similarity index 98% rename from docs/build_notes_windows.md rename to docs/building/windows.md index 2b4b96b6..5c9fda5a 100644 --- a/docs/build_notes_windows.md +++ b/docs/building/windows.md @@ -3,7 +3,7 @@ Building on Windows There are two approaches available to build i2pd on Windows. The best one depends on your needs and personal preferences. One is to use -msys2 and [unix alike infrastructure](build_notes_unix.md). Another +msys2 and [unix alike infrastructure](unix.md). Another one is to use Visual Studio. While there might be no difference for end users of i2pd daemon, developers, however, shall be wary of differences in C++ name mangling between the two compilers when making @@ -20,8 +20,6 @@ development location for the sake of convenience. Adjust paths accordingly if it is not the case. Note that msys uses unix-alike paths like /c/dev/ for C:\dev\. - - msys2 ----- diff --git a/docs/index.rst b/docs/index.rst index 8cfddb24..c1061171 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,14 +29,13 @@ Contents: .. toctree:: :maxdepth: 2 - build_requirements - build_notes_unix - build_notes_windows - build_notes_cross - build_notes_android - build_notes_ios + building/requirements + building/unix + building/windows + building/cross + building/android + building/ios configuration family usage -