added GPL header to all files and added INSTALL AUTHORS COPYING files.

[NeonServV5.git] / INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..6ac9d23
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,64 @@
+             NeonServ Installation Instructions
+
+Introduction:
+----------
+If you encounter any problems compiling/running NeonServ, please make 
+sure you have followed the directions in this file correctly and that 
+all of the requirements listed below are met.
+
+If the problem persists, report it to one (or all) of the coders
+listed in the AUTHORS file. Please try to include ALL relevant
+information about the error/bug, including anything out of the
+ordinary reported from make and the appropriate entries from the log
+files.
+
+Quick Install:
+----------
+$ ./autogen.sh
+$ ./configure
+$ make
+$ ${EDITOR} neonserv.ini
+    NOTE: You may want to copy neonserv.example.ini to neonserv.ini and
+    edit that.
+$ ./neonserv
+
+Compiling:
+----------
+  1) Enter the root directory of the NeonServ tree.  If installation is 
+     done from outside of it, it may cause problems during compile, or 
+     during runtime.
+
+  2) If you've cloned a development snapshot of NeonServ from git.pk910.de
+     you need to generate the configure and Makefile files. For that you
+     simply need to run the autogen.sh script.
+     (chmood it to be executeable if needed)
+
+  3) Run the configure script (sh configure), it will verify that your
+     system will have the resources needed for NeonServ to compile. If 
+     you would like to change the path where NeonServ will be installed 
+     to, execute configure with the --prefix=/path option.  The default 
+     path is ~/neonserv/.
+
+
+  4) You may optionally edit config.h in case the configure script made a
+     mistake.
+
+  5) Execute the "make" command to begin compiling.  If you encounter any
+     uncorrectable errors/warnings, please scroll up to the introduction
+     section and follow the instructions.
+
+  6) You may now either type "make install" to install it to your
+     installation path, or work from your build directory, either is fine.
+
+  7) Copy neonserv.example.ini to neonserv.ini and edit the mysql information.
+
+ 10) Once you have NeonServ for the first time, it will create the neccesary
+     tables in your database. Take a look into `bots` to edit Bot settings like
+     nick and server (You need to restart the bot to apply these settings). 
+     You also need to add youself into the `users` table with 1000 access. 
+
+ 11) You can now register a channel via the bots query ;)
+
+End of file, INSTALL.
+
+-pk910 (neonserv@pk910.de)