From e1211a68e5a7d85bca7ad7fc6d13418a2c12093b Mon Sep 17 00:00:00 2001
From: Sadie Powell <sadie@witchery.services>
Date: Thu, 21 May 2020 00:03:26 +0100
Subject: Add a file to the config directory telling new users what to do.

---
 make/template/help.txt | 19 +++++++++++++++++++
 make/template/main.mk  |  1 +
 2 files changed, 20 insertions(+)
 create mode 100644 make/template/help.txt

(limited to 'make')

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@`.
diff --git a/make/template/main.mk b/make/template/main.mk
index 6bd1d390d..380d57f27 100644
--- a/make/template/main.mk
+++ b/make/template/main.mk
@@ -246,6 +246,7 @@ endif
 	-$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) docs/conf/providers/*.example $(EXAPATH)/providers
 	-$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) docs/conf/services/*.example $(EXAPATH)/services
 	-$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) docs/sql/*.sql $(EXAPATH)/sql
+	-$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_TXT) @CONFIGURE_DIRECTORY@/help.txt $(CONPATH)
 	-$(INSTALL) -g @GID@ -o @UID@ -m $(INSTMODE_PRV) *.pem $(CONPATH) 2>/dev/null
 	@echo ""
 	@echo "*************************************"
-- 
cgit v1.2.3