From a00cb3f8cd1e666131008ac2c3b74c74700f9e07 Mon Sep 17 00:00:00 2001 From: Daniel Oaks Date: Sun, 1 Apr 2018 12:09:12 +1000 Subject: [PATCH] manual: Add basic Commands section that just points to integrated help --- docs/MANUAL.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/MANUAL.md b/docs/MANUAL.md index ad9e0b2c..20bf5841 100644 --- a/docs/MANUAL.md +++ b/docs/MANUAL.md @@ -28,6 +28,7 @@ _Copyright © 2018 Daniel Oaks _ - User Modes - Channel Modes - Channel Prefixes +- Commands - Acknowledgements @@ -89,7 +90,7 @@ To start the server, type `oragono.exe run` and hit enter, and the server should To get started with Oragono on macOS, Linux, or on a Raspberry Pi: -1. Make sure you have the [latest release](https://github.com/oragono/oragono/releases/latest) downloaded. +1. Make sure you have the [latest release](https://github.com/oragono/oragono/releases/latest) for your OS/distro downloaded. 2. Extract the tar.gz file to a folder. 3. Copy and rename `oragono.yaml` to `ircd.yaml`. 4. Open up `ircd.yaml` using any text editor, and then save it once you're happy. @@ -371,6 +372,24 @@ Voiced users can speak when the channel has `+m - Moderated` mode enabled. They -------------------------------------------------------------------------------------------- +# Commands + +The best place to look for command help is on a running copy or Oragono itself! + +To see the integrated command help, simply spin up a copy of Oragono and then run this command: + + /HELPOP + +If that doesn't work, you may need to run this instead: + + /QUOTE HELP + +We may add some additional notes here for specific commands down the line, but right now the in-server docs are the best ones to consult. + + +-------------------------------------------------------------------------------------------- + + # Acknowledgements Always, thanks to Jeremy Latt for creating Ergonomadic. Thanks for Edmund Huber for maintaining Ergonomadic and providing useful help while transitioning.