ircd.chat/ircd
11
1
Fork 0
Code Issues Pull Requests 1 Releases Wiki Activity

manual: Add basic Commands section that just points to integrated help

Browse Source
This commit is contained in:
Daniel Oaks 2018-04-01 12:09:12 +10:00
parent ada1d0a091
commit a00cb3f8cd
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/MANUAL.md
View File

@ -28,6 +28,7 @@ _Copyright © 2018 Daniel Oaks <daniel@danieloaks.net>_
- User Modes - User Modes
- Channel Modes - Channel Modes
- Channel Prefixes - Channel Prefixes
- Commands
- Acknowledgements - 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: 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. 2. Extract the tar.gz file to a folder.
3. Copy and rename `oragono.yaml` to `ircd.yaml`. 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. 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 <command>
If that doesn't work, you may need to run this instead:
/QUOTE HELP <command>
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 # Acknowledgements
Always, thanks to Jeremy Latt for creating Ergonomadic. Thanks for Edmund Huber for maintaining Ergonomadic and providing useful help while transitioning. Always, thanks to Jeremy Latt for creating Ergonomadic. Thanks for Edmund Huber for maintaining Ergonomadic and providing useful help while transitioning.