Browse Source

* reorganize docs in build-notes*.md

pull/690/head
hagen 8 years ago
parent
commit
8e1687e7b3
  1. 15
      docs/build_requirements.md
  2. 0
      docs/building/android.md
  3. 0
      docs/building/cross.md
  4. 0
      docs/building/ios.md
  5. 14
      docs/building/requirements.md
  6. 0
      docs/building/unix.md
  7. 4
      docs/building/windows.md
  8. 13
      docs/index.rst

15
docs/build_requirements.md

@ -1,15 +0,0 @@ @@ -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.

0
docs/build_notes_android.md → docs/building/android.md

0
docs/build_notes_cross.md → docs/building/cross.md

0
docs/build_notes_ios.md → docs/building/ios.md

14
docs/building/requirements.md

@ -0,0 +1,14 @@ @@ -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)

0
docs/build_notes_unix.md → docs/building/unix.md

4
docs/build_notes_windows.md → docs/building/windows.md

@ -3,7 +3,7 @@ Building on Windows @@ -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 @@ -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
-----

13
docs/index.rst

@ -29,14 +29,13 @@ Contents: @@ -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

Loading…
Cancel
Save