Browse Source

tweak some manual language

tags/v2.2.0-rc1
Shivaram Lingamneni 3 years ago
parent
commit
76b534476a
2 changed files with 5 additions and 13 deletions
  1. 1
    2
      README
  2. 4
    11
      README.md

+ 1
- 2
README View File

@@ -25,8 +25,7 @@ Copy the example config file to ircd.yaml with a command like:
25 25
 
26 26
     $ cp default.yaml ircd.yaml
27 27
 
28
-Modify the config file as you like. In particular, the `connection-throttling` and
29
-`connection-limits` sections are working looking over and tuning for your network's needs.
28
+Modify the config file as you like.
30 29
 
31 30
 To generate passwords for opers and connect passwords, you can use this command:
32 31
 

+ 4
- 11
README.md View File

@@ -42,16 +42,17 @@ If you want to take a look at a running Oragono instance or test some client cod
42 42
 * [IRCv3 support](https://ircv3.net/software/servers.html)
43 43
 * a heavy focus on developing with [specifications](https://oragono.io/specs.html)
44 44
 
45
-## Installation
45
+## Quick start guide
46 46
 
47
-To go through the standard installation, download the latest release from this page: https://github.com/oragono/oragono/releases/latest
47
+Download the latest release from this page: https://github.com/oragono/oragono/releases/latest
48 48
 
49 49
 Extract it into a folder, then run the following commands:
50 50
 
51 51
 ```sh
52 52
 cp default.yaml ircd.yaml
53
-vim ircd.yaml  # modify the config file to your liking
53
+vim ircd.yaml   # modify the config file to your liking
54 54
 oragono mkcerts
55
+oragono run     # server should be ready to go!
55 56
 ```
56 57
 
57 58
 **Note:** See the [productionizing guide in our manual](https://github.com/oragono/oragono/blob/master/docs/MANUAL.md#productionizing) for recommendations on how to run a production network, including obtaining valid TLS certificates.
@@ -102,14 +103,6 @@ oragono genpasswd
102 103
 
103 104
 With this, you receive a blob of text which you can plug into your configuration file.
104 105
 
105
-## Running
106
-
107
-After this, running the server is easy! Simply run the below command and you should see the relevant startup information pop up.
108
-
109
-```sh
110
-oragono run
111
-```
112
-
113 106
 ### How to register a channel
114 107
 
115 108
 1. Register your account with `/NS REGISTER <password>`

Loading…
Cancel
Save