Improve the docs

st-tu-dresden · Mar 8, 2018 · 3b974a5 · 3b974a5
1 parent 034cdf7
commit 3b974a5
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -30,9 +30,10 @@ INLOOP requires the following software:
 
 * Debian 8+ or Ubuntu 16.04+, macOS 10.11+ (for development only)
 * Python 3.4, 3.5 or 3.6
-* Docker 1.10+ ([Docker setup](docs/DOCKER_SETUP.md) **!!!**)
+* Docker 1.10+ ([Docker setup](docs/docker_setup.md) **!!!**)
 * Redis 2.6+
-* Git 2.3+
+* Git 2.3+ ([workarounds for older Git versions](docs/git_troubleshouting.md))
+* PostgreSQL 9.3+ (for production deployment, not needed for development)
 
 Using the command line, a development instance can be set up as follows:
 
@@ -50,7 +51,7 @@ Using the command line, a development instance can be set up as follows:
    *secret*.
 
 
-## Further documentation
+## Documentation
 
 * [Installation/deployment manual](docs/INSTALL.md)
 * [Contributor guide](CONTRIBUTING.md)

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -42,7 +42,7 @@ Prerequisites
 other modern Linux distribution should also do the trick, given that it is able to run Docker and
 Python (see the [README](../README.md) for exact version requirements).
 
-**Docker setup**: see the [Docker installation notes](DOCKER_SETUP.md).
+**Docker setup**: see the [Docker installation notes](docker_setup.md).
 
 **Hostname setup:** verify that your system's hostname is configured correctly. `hostname` and
 `hostname -f` should print the short and fully qualified hostname of your machine, e.g.:

diff --git a/docs/DOCKER_SETUP.md → docs/docker_setup.md b/docs/DOCKER_SETUP.md → docs/docker_setup.md
diff --git a/docs/GIT_TROUBLESHOUTING.md → docs/git_troubleshouting.md b/docs/GIT_TROUBLESHOUTING.md → docs/git_troubleshouting.md
diff --git a/support/scripts/debian_setup.sh b/support/scripts/debian_setup.sh
@@ -25,7 +25,7 @@ echo "Checking Docker prerequisites..."
 
 if ! command -v docker >/dev/null; then
     echo 'I cannot find a `docker` executable in your PATH. Please make sure' >&2
-    echo 'you have installed Docker as described in docs/DOCKER_SETUP.md.' >&2
+    echo 'you have installed Docker as described in docs/docker_setup.md.' >&2
     exit 1
 fi
 
@@ -37,7 +37,7 @@ fi
 
 if ! grep -q swapaccount=1 /proc/cmdline; then
     echo 'Swap accounting seems to be disabled. Please make sure you have' >&2
-    echo 'configured GRUB as described in docs/DOCKER_SETUP.md.' >&2
+    echo 'configured GRUB as described in docs/docker_setup.md.' >&2
     exit 1
 fi