commit 047f6b37e589f1965ff3ae65231400403bece2d1 Author: juga0 juga@riseup.net Date: Fri Nov 30 13:46:31 2018 +0000
docs: Advice to read the documentation at rtfd.io
or from a local build or from the Debian package sbws-doc, since the Sphinx directives are not ReST and therefore not rendered in Github. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+)
diff --git a/README.md b/README.md index 93a1653..b001943 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,15 @@ on the public Tor network. Please do not run this software on the public Tor network unless you are one of the Tor bandwidth authorities, to avoid creating unnecessary traffic.
+**ADVICE**: It is recommended to read this documentation at +[Read the Docs](https://sbws.rtfd.io). In +[Github](http://github.com/torproject/sbws) some links won't be properly +rendered. +It can also be read after installing the Debian package ``sbws-doc`` in +``/usr/share/doc/sbws`` or after building it locally as explained in +``./docs/source/documenting.rst``. + + Installing ------------