[tor-commits] [sbws/master] Create sections for links to documentation

[juga@xxxxxxxxxxxxxx]

commit 164cc7b4ef29f64e7089acffe0d6a95f40566208
Author: juga0 <juga@xxxxxxxxxx>
Date:   Mon Sep 17 14:59:47 2018 +0000

    Create sections for links to documentation
---
 README.md | 35 ++++++++++++++++++++++++++++-------
 1 file changed, 28 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 38cb183..99466f0 100644
--- a/README.md
+++ b/README.md
@@ -13,14 +13,35 @@ authorities or researches using a test Tor network, chutney or shadow.
 Please, do not run this software otherwise, since the measurements would not be
 used by Tor and would only create more traffic in the Tor network.
 
-See ./INSTALL.rst) for install instructions,
-[./DEPLOY.rst](./DEPLOY.rst) for deploy instructions,
-[./CONTRIBUTING](./CONTRIBUTING.rst) for contribution guidelines.
-=======
-`sbws` will be considered production ready when version 1.0.0 will be releases.
+`sbws` will be considered production ready when version 1.0.0 will be released.
+
+Installing
+------------
+
+See ./INSTALL.rst (or  [INSTALL](./INSTALL.rst) or [INSTALL](./INSTALL.html) )
+
+Deploying and running
+---------------------
+
+See ./DEPLOY.rst (or  [DEPLOY](./DEPLOY.rst) or [DEPLOY](./DEPLOY.html) )
+
+Contributing
+--------------
+
+See ./CONTRIBUTING.rst (or  [CONTRIBUTING](./CONTRIBUTING.rst) or
+[CONTRIBUTING](./CONTRIBUTING.html) )
+
+Changelog
+--------------
+
+See ./CHANGELOG.rst (or  [CHANGELOG](./CHANGELOG.rst) or
+[CHANGELOG](./CHANGELOG.html) )
+
+Documentation
+--------------
 
 More extensive documentation can be found in the ./docs directory,
-also online at https://sbws.readthedocs.io and
+and online at [sbws.rtfd.io](https://sbws.readthedocs.io) and
 [this onion service](http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/)
 ([v2](http://sdmb3rfvp3wadu6y.onion/)).
 
@@ -36,4 +57,4 @@ software in ./LICENSE.md
 
 ## Authors
 
-See ./AUTHORS.md
\ No newline at end of file
+See ./AUTHORS.md (or  [AUTHORS](./AUTHORS.MD)
\ No newline at end of file



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits