summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorkatsel <katsel@users.noreply.github.com>2016-10-02 18:28:17 +0200
committerkatsel <katsel@users.noreply.github.com>2016-10-02 18:47:43 +0200
commit8d6b9c0a3955b62e613bf9e9e7b78e06ccfa542c (patch)
treecd47fecccd4ce044aebcbbe2c6a96d5345f5e506 /README.rst
parent00cf5f4956a9580bc5e6147816a514232c78c9dc (diff)
downloadcouchdb-8d6b9c0a3955b62e613bf9e9e7b78e06ccfa542c.tar.gz
README.rst, README-DEV.rst: Code should be in double backquotes
Minor fixes, improves readability of README files on github a lot.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index 611b2f514..a15804238 100644
--- a/README.rst
+++ b/README.rst
@@ -56,17 +56,17 @@ Getting started with developing
For more detail, read the README-DEV.rst file in this directory.
Basically you just have to install the needed dependencies which are
-documented in the install docs and then run `./configure && make`.
+documented in the install docs and then run ``./configure && make``.
-You don't need to run `make install` after compiling, just use
-`./dev/run` to spin up three nodes. You can add haproxy as a caching
-layer in front of this cluster by running `./dev/run --with-haproxy
---haproxy=/path/to/haproxy` . You will now have a local cluster
-listening on port `5984`.
+You don't need to run ``make install`` after compiling, just use
+``./dev/run`` to spin up three nodes. You can add haproxy as a caching
+layer in front of this cluster by running ``./dev/run --with-haproxy
+--haproxy=/path/to/haproxy`` . You will now have a local cluster
+listening on port 5984.
For Fauxton developers fixing the admin-party does not work via the button in
-Fauxton. To fix the admin party you have to run `./dev/run` with the `admin`
-flag, e.g. `./dev/run --admin=username:password`. If you want to have an
+Fauxton. To fix the admin party you have to run ``./dev/run`` with the ``admin``
+flag, e.g. ``./dev/run --admin=username:password``. If you want to have an
admin-party, just omit the flag.
Cryptographic Software Notice