summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-06-20 15:45:00 +0100
committerMichael Williamson <mike@zwobble.org>2014-06-20 15:45:00 +0100
commitce1ea373a1ddcbe0ac9369471ae8e3ccbafb6510 (patch)
tree21d5cd17bf3c1b285df40aba1aa78dd2e9650271 /README.rst
parentae3c18ef2934b88d0aedd0567a410ce23bb95ceb (diff)
Update installation section of README
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index 6e78368..f4c2cf4 100644
--- a/README.rst
+++ b/README.rst
@@ -3,10 +3,23 @@ jq.py: a lightweight and flexible JSON processor
This project contains Python bindings for
`jq <http://stedolan.github.io/jq/>`_.
-Installation requires Git and any programs required to build jq, such as gcc.
+
+Installation
+------------
During installation,
-jq 1.4 is cloned from GitHub and built.
+jq 1.4 is downloaded over HTTPS from GitHub and built.
+Therefore, installation requires any programs required to build jq.
+This includes:
+
+* The normal C compiler toolchain, such as gcc and make.
+ Installable on Debian, Ubuntu and relatives by installing the package ``build-essential``.
+
+* Autoconf
+
+* Flex
+
+* Bison
Usage
-----