From 9a2e948c426883089d4fb1e9567145ac201b53a1 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Thu, 6 Apr 2017 20:13:00 +0900 Subject: [PATCH] Update doc Add section to promote the build from tar archives. --- README.rst | 52 ++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 36 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 319184bf..06e33a45 100644 --- a/README.rst +++ b/README.rst @@ -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 enable it, use ``--with-neverbleed`` configure option. -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 - -To compile the source code, gcc >= 4.8.3 or clang >= 3.4 is required. +In ordre to compile the source code, gcc >= 4.8.3 or clang >= 3.4 is +required. .. 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 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) ------------------------------------