Update doc

Add section to promote the build from tar archives.
This commit is contained in:
Tatsuhiro Tsujikawa 2017-04-06 20:13:00 +09:00
parent df814223ff
commit 9a2e948c42
1 changed files with 36 additions and 16 deletions

View File

@ -157,22 +157,8 @@ minimizes the risk of private key leakage when serious bug like
Heartbleed is exploited. The neverbleed is disabled by default. To Heartbleed is exploited. The neverbleed is disabled by default. To
enable it, use ``--with-neverbleed`` configure option. enable it, use ``--with-neverbleed`` configure option.
Building from git In ordre to compile the source code, gcc >= 4.8.3 or clang >= 3.4 is
----------------- required.
Building from git is easy, but please be sure that at least autoconf 2.68 is
used:
.. code-block:: text
$ git submodule update --init
$ autoreconf -i
$ automake
$ autoconf
$ ./configure
$ make
To compile the source code, gcc >= 4.8.3 or clang >= 3.4 is required.
.. note:: .. note::
@ -219,6 +205,40 @@ To compile the source code, gcc >= 4.8.3 or clang >= 3.4 is required.
responsible to specify the correct values to these variables. For responsible to specify the correct values to these variables. For
complete list of these variables, run ``./configure -h``. complete list of these variables, run ``./configure -h``.
Building nghttp2 from release tar archive
-----------------------------------------
The nghttp2 project regularly releases tar archives which includes
nghttp2 source code, and generated build files. They can be
downloaded from
[Releases](https://github.com/nghttp2/nghttp2/releases) page.
Building nghttp2 from git requires autotools development packages.
Building from tar archives does not require them, and thus it is much
easier. The usual build step is as follows:
.. code-block:: text
$ tar xf nghttp2-X.Y.Z.tar.bz2
$ cd nghttp2-X.Y.Z
$ ./configure
$ make
Building from git
-----------------
Building from git is easy, but please be sure that at least autoconf 2.68 is
used:
.. code-block:: text
$ git submodule update --init
$ autoreconf -i
$ automake
$ autoconf
$ ./configure
$ make
Notes for building on Windows (MSVC) Notes for building on Windows (MSVC)
------------------------------------ ------------------------------------