From 76b534476a74233a93c84a2d6457e938939456cf Mon Sep 17 00:00:00 2001 From: Shivaram Lingamneni Date: Thu, 18 Jun 2020 13:56:47 -0400 Subject: [PATCH] tweak some manual language --- README | 3 +-- README.md | 15 ++++----------- 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/README b/README index e64c8180..e199bace 100644 --- a/README +++ b/README @@ -25,8 +25,7 @@ Copy the example config file to ircd.yaml with a command like: $ cp default.yaml ircd.yaml -Modify the config file as you like. In particular, the `connection-throttling` and -`connection-limits` sections are working looking over and tuning for your network's needs. +Modify the config file as you like. To generate passwords for opers and connect passwords, you can use this command: diff --git a/README.md b/README.md index 7f89d1f3..341835d0 100644 --- a/README.md +++ b/README.md @@ -42,16 +42,17 @@ If you want to take a look at a running Oragono instance or test some client cod * [IRCv3 support](https://ircv3.net/software/servers.html) * a heavy focus on developing with [specifications](https://oragono.io/specs.html) -## Installation +## Quick start guide -To go through the standard installation, download the latest release from this page: https://github.com/oragono/oragono/releases/latest +Download the latest release from this page: https://github.com/oragono/oragono/releases/latest Extract it into a folder, then run the following commands: ```sh cp default.yaml ircd.yaml -vim ircd.yaml # modify the config file to your liking +vim ircd.yaml # modify the config file to your liking oragono mkcerts +oragono run # server should be ready to go! ``` **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 With this, you receive a blob of text which you can plug into your configuration file. -## Running - -After this, running the server is easy! Simply run the below command and you should see the relevant startup information pop up. - -```sh -oragono run -``` - ### How to register a channel 1. Register your account with `/NS REGISTER `