Browse Source

add links in README.md to manual/userguide

tags/v2.8.0-rc1
Shivaram Lingamneni 3 years ago
parent
commit
ece82b44fb
1 changed files with 7 additions and 2 deletions
  1. 7
    2
      README.md

+ 7
- 2
README.md View File

@@ -41,6 +41,11 @@ If you want to take a look at a running Ergo instance or test some client code,
41 41
 * [IRCv3 support](https://ircv3.net/software/servers.html)
42 42
 * a focus on developing with [specifications](https://ergo.chat/specs.html)
43 43
 
44
+For more detailed information on Ergo's functionality, see:
45
+
46
+* [MANUAL.md, the operator manual](https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md)
47
+* [USERGUIDE.md, the guide for end users](https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md)
48
+
44 49
 ## Quick start guide
45 50
 
46 51
 Download the latest release from this page: https://github.com/ergochat/ergo/releases/latest
@@ -54,7 +59,7 @@ ergo mkcerts
54 59
 ergo run     # server should be ready to go!
55 60
 ```
56 61
 
57
-**Note:** See the [productionizing guide in our manual](https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#productionizing-with-systemd) for recommendations on how to run a production network, including obtaining valid TLS certificates.
62
+**Note:** See the [productionizing guide in our manual](https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md#productionizing-with-systemd) for recommendations on how to run a production network, including obtaining valid TLS certificates.
58 63
 
59 64
 ### Platform Packages
60 65
 
@@ -76,7 +81,7 @@ You can also install this repo and use that instead! However, keep some things i
76 81
 
77 82
 The `master` branch _should_ usually be stable, but may contain database changes that either have not been finalised or not had database upgrade code written yet. Don't run `master` on a live production network.
78 83
 
79
-The `stable` branch contains the latest release. You can run this for a production version without any trouble.
84
+The `stable` branch contains the latest release, suitable for use in production.
80 85
 
81 86
 #### Building
82 87
 

Loading…
Cancel
Save