Browse Source

docs: Move things to this dir, fill it out a bit

tags/v0.2.0
Daniel Oaks 7 years ago
parent
commit
8320c37ed4
2 changed files with 35 additions and 0 deletions
  1. 0
    0
      docs/CHANGELOG.md
  2. 35
    0
      docs/README

CHANGELOG.md → docs/CHANGELOG.md View File


+ 35
- 0
docs/README View File

@@ -0,0 +1,35 @@
1
+
2
+                                 ▄▄▄   ▄▄▄·  ▄▄ •        ▐ ▄       
3
+                           ▪     ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪     •█▌▐█▪     
4
+                            ▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄ 
5
+                           ▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
6
+                            ▀█▄▀▪.▀  ▀ ▀  ▀ ·▀▀▀▀  ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
7
+
8
+-----------------------------------------------------------------------------------------------
9
+
10
+Oragono is a modern, experimental IRC server written in Go. It's designed to be simple to setup
11
+and use, and to provide the majority of features that IRC users expect today.
12
+
13
+It includes features such as UTF-8 nicks and channel names, client accounts and SASL, and other
14
+assorted IRCv3 support.
15
+
16
+                             https://github.com/DanielOaks/oragono
17
+
18
+-----------------------------------------------------------------------------------------------
19
+
20
+
21
+=== Installing ===
22
+
23
+Copy the example config file to ircd.yaml with a command like:
24
+
25
+    $ cp oragono.yaml ircd.yaml
26
+
27
+Modify the config file as you like.
28
+
29
+Run these commands in order -- these will setup each section of the server:
30
+
31
+    $ oragono initdb
32
+    $ oragono mkcerts
33
+    $ oragono run
34
+
35
+And you should now be running Oragono!

Loading…
Cancel
Save