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

2024-11-22 03:49:27 +01:00 · 2016-10-16 21:01:53 +10:00 · 2016-10-16 21:01:53 +10:00 · 8320c37ed4
commit 8320c37ed4
parent 41d534d6dd
2 changed files with 35 additions and 0 deletions
--- a/docs/CHANGELOG.md
+++ b/docs/CHANGELOG.md
--- a/docs/README
+++ b/docs/README
@ -0,0 +1,35 @@
+
+                                 ▄▄▄   ▄▄▄·  ▄▄ •        ▐ ▄       
+                           ▪     ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪     •█▌▐█▪     
+                            ▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄ 
+                           ▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
+                            ▀█▄▀▪.▀  ▀ ▀  ▀ ·▀▀▀▀  ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
+
+-----------------------------------------------------------------------------------------------
+
+Oragono is a modern, experimental IRC server written in Go. It's designed to be simple to setup
+and use, and to provide the majority of features that IRC users expect today.
+
+It includes features such as UTF-8 nicks and channel names, client accounts and SASL, and other
+assorted IRCv3 support.
+
+                             https://github.com/DanielOaks/oragono
+
+-----------------------------------------------------------------------------------------------
+
+
+=== Installing ===
+
+Copy the example config file to ircd.yaml with a command like:
+
+    $ cp oragono.yaml ircd.yaml
+
+Modify the config file as you like.
+
+Run these commands in order -- these will setup each section of the server:
+
+    $ oragono initdb
+    $ oragono mkcerts
+    $ oragono run
+
+And you should now be running Oragono!