Browse Source

Tuning docs for Sphinx

pull/317/head
libre-net-society 9 years ago
parent
commit
623edf3bc9
  1. 19
      docs/build_notes_unix.md
  2. 2
      docs/build_notes_windows.md
  3. 15
      docs/build_requirements.md
  4. 5
      docs/configuration.md
  5. 1
      docs/index.rst

19
docs/build_notes_unix.md

@ -1,20 +1,5 @@ @@ -1,20 +1,5 @@
Requirements
============
Linux/FreeBSD/OSX
-----------------
GCC 4.6 or newer, Boost 1.46 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.
Build notes
===========
Building on Unix systems
=============================
Common build/install process from sources:

2
docs/build_notes_windows.md

@ -1,4 +1,4 @@ @@ -1,4 +1,4 @@
Building i2pd on Windows
Building on Windows
=========================
There are two approaches available to build i2pd on Windows. The best

15
docs/build_requirements.md

@ -0,0 +1,15 @@ @@ -0,0 +1,15 @@
Build requirements
============
Linux/FreeBSD/OSX
-----------------
GCC 4.6 or newer, Boost 1.46 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.

5
docs/configuration.md

@ -1,4 +1,7 @@ @@ -1,4 +1,7 @@
i2pd cmdline options
i2pd configuration
==================
Command line options
--------------------
* --host= - The external IP (deprecated).

1
docs/index.rst

@ -22,6 +22,7 @@ Contents: @@ -22,6 +22,7 @@ Contents:
.. toctree::
:maxdepth: 2
build_requirements
build_notes_unix
build_notes_windows
configuration

Loading…
Cancel
Save