Name the packages the build needs

1 file changed, 11 insertions, 5 deletions

diff --git a/README.txt b/README.txtindex 65ced13..0279bf4 100644--- a/README.txt+++ b/README.txt@@ -11,6 +11,13 @@ Installation Building cgit involves building a proper version of Git. How to do this depends on how you obtained the cgit sources. +The build needs GNU make, run as gmake on the BSDs, a C compiler and the zlib+headers, and make get-git below also needs curl or wget, and xz. zlib is the+only library cgit requires, so no development packages for OpenSSL, libcurl,+gettext or Tcl are needed. On Debian and Ubuntu that is one command.++    $ sudo apt install make gcc zlib1g-dev curl xz-utils+ In a cloned cgit repository, first fetch the Git submodule.      $ git submodule update --init@@ -29,9 +36,6 @@ into /var/www/htdocs/cgit, and the Lua filters from custom/extensions into /usr/local/lib/cgit/filters. The locations and a few other things can be changed by providing a cgit.conf file, see the Makefile for details. -The only required library is zlib. cgit builds without OpenSSL, libcurl,-gettext or Tcl, so no development packages for those are needed.- On a musl system such as Alpine, Git's code also needs the Linux kernel headers, packaged there as linux-headers, and its bundled regex in place of musl's, which lacks REG_STARTEND. make test takes the same setting.@@ -40,8 +44,10 @@ lacks REG_STARTEND. make test takes the same setting.  Lua is optional and only powers the lua: filter extensions, the filters in custom/extensions/. A plain build auto-detects a Lua through pkg-config,-preferring LuaJIT, and falls back to a Lua-less binary when none is found. To-pin an implementation, name its pkg-config module.+preferring LuaJIT, and falls back to a Lua-less binary when none is found. On+Debian and Ubuntu, detection needs pkg-config and a development package such as+libluajit-5.1-dev or liblua5.4-dev. To pin an implementation, name its+pkg-config module.      $ make LUA_PKGCONFIG=lua5.4 
diff --git a/README.txt b/README.txt
index 65ced13..0279bf4 100644
--- a/README.txt
+++ b/README.txt
@@ -11,6 +11,13 @@ Installation
 Building cgit involves building a proper version of Git. How to do this depends
 on how you obtained the cgit sources.
 
+The build needs GNU make, run as gmake on the BSDs, a C compiler and the zlib
+headers, and make get-git below also needs curl or wget, and xz. zlib is the
+only library cgit requires, so no development packages for OpenSSL, libcurl,
+gettext or Tcl are needed. On Debian and Ubuntu that is one command.
+
+    $ sudo apt install make gcc zlib1g-dev curl xz-utils
+
 In a cloned cgit repository, first fetch the Git submodule.
 
     $ git submodule update --init
@@ -29,9 +36,6 @@ into /var/www/htdocs/cgit, and the Lua filters from custom/extensions into
 /usr/local/lib/cgit/filters. The locations and a few other things can be changed
 by providing a cgit.conf file, see the Makefile for details.
 
-The only required library is zlib. cgit builds without OpenSSL, libcurl,
-gettext or Tcl, so no development packages for those are needed.
-
 On a musl system such as Alpine, Git's code also needs the Linux kernel headers,
 packaged there as linux-headers, and its bundled regex in place of musl's, which
 lacks REG_STARTEND. make test takes the same setting.
@@ -40,8 +44,10 @@ lacks REG_STARTEND. make test takes the same setting.
 
 Lua is optional and only powers the lua: filter extensions, the filters in
 custom/extensions/. A plain build auto-detects a Lua through pkg-config,
-preferring LuaJIT, and falls back to a Lua-less binary when none is found. To
-pin an implementation, name its pkg-config module.
+preferring LuaJIT, and falls back to a Lua-less binary when none is found. On
+Debian and Ubuntu, detection needs pkg-config and a development package such as
+libluajit-5.1-dev or liblua5.4-dev. To pin an implementation, name its
+pkg-config module.
 
     $ make LUA_PKGCONFIG=lua5.4