Added new GIT.txt describing the basic usage of GIT for ngIRCd.

[ngircd-web.git] / doc / GIT.txt

diff --git a/doc/GIT.txt b/doc/GIT.txt
new file mode 100644 (file)
index 0000000..c42696d
--- /dev/null
+++ b/doc/GIT.txt
@@ -0,0 +1,45 @@
+                     ngIRCd - Next Generation IRC Server
+
+                                 -- GIT.txt --
+
+The source code of ngIRCd is maintained using git, the stupid content
+tracker.
+
+I. Getting the source code
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+To access the source tree anonymously, run:
+
+ $ git clone git://ngircd.barton.de/ngircd.git
+
+Thereby a new folder "ngircd" will be created containing all the individual
+source files.
+
+The newly created directory ("ngircd") is the "working directory", all
+git commands will be executed from within this directory in the future.
+
+Please note: When checking out a fresh copy of ngIRCd using git, the
+configure script doesn't exist; you have to run the autogen.sh shell script
+(which is included in the source tree) to generate it. This requires you to
+have GNU automake and GNU autoconf installed on your system.
+
+To update the git tree:
+
+ $ git pull
+
+This retrieves all changes and merges them into the current branch.
+
+II. Contributing
+~~~~~~~~~~~~~~~~
+
+Patches should be sent to the ngircd mailing list. List homepage:
+http://arthur.barton.de/mailman/listinfo/ngircd-ml
+
+If you do not want to send them to the list, you can also mail them
+to Alex Barton, <alex@barton.de>.
+
+
+III. Write Access
+~~~~~~~~~~~~~~~~~
+If you want to contribute a couple of patches and write access to the git
+repository would be handy, please contact Alex Barton, <alex@barton.de>.
+