From ece82b44fb9ecdc74ca44b8b2821eccaa83a1fed Mon Sep 17 00:00:00 2001 From: Shivaram Lingamneni Date: Tue, 15 Jun 2021 19:45:29 -0400 Subject: [PATCH] add links in README.md to manual/userguide --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eb9e714d..61c02d44 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ If you want to take a look at a running Ergo instance or test some client code, * [IRCv3 support](https://ircv3.net/software/servers.html) * a focus on developing with [specifications](https://ergo.chat/specs.html) +For more detailed information on Ergo's functionality, see: + +* [MANUAL.md, the operator manual](https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md) +* [USERGUIDE.md, the guide for end users](https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md) + ## Quick start guide Download the latest release from this page: https://github.com/ergochat/ergo/releases/latest @@ -54,7 +59,7 @@ ergo mkcerts ergo run # server should be ready to go! ``` -**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. +**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. ### Platform Packages @@ -76,7 +81,7 @@ You can also install this repo and use that instead! However, keep some things i 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. -The `stable` branch contains the latest release. You can run this for a production version without any trouble. +The `stable` branch contains the latest release, suitable for use in production. #### Building