Add a file to the config directory telling new users what to do.

1 files changed, 19 insertions, 0 deletions

diff --git a/make/template/help.txt b/make/template/help.txt
new file mode 100644
index 000000000..0afe91e02
--- /dev/null
+++ b/make/template/help.txt
@@ -0,0 +1,19 @@
+Thanks for installing InspIRCd!
+
+In order to get your server running you need to create config files. Examples
+can be found at `@EXAMPLE_DIR@`.
+
+If you need any help with this then you can visit our support channel at
+irc.inspircd.org #inspircd or refer to the the docs site:
+
+	https://docs.inspircd.org/@VERSION_MAJOR@/configuration
+	https://docs.inspircd.org/@VERSION_MAJOR@/modules
+
+When you are done you can run the following command to start InspIRCd:
+
+	@BINARY_DIR@/inspircd
+
+If you have installed from an official package you may need to prefix this
+command with `sudo -g @GROUP@ -u @USER@` to run as the correct group/user.
+
+You can also use one of the helper scripts in `@SCRIPT_DIR@`.