about summary refs log tree commit diff
path: root/doc/GIT.txt
diff options
context:
space:
mode:
authorFlorian Westphal <fw@strlen.de>2008-04-12 21:10:47 +0200
committerAlexander Barton <alex@barton.de>2008-04-12 21:51:15 +0200
commit248f8e0b7036b113e0d5a4b66f4b7d2db68a038f (patch)
tree21ec84b38045549fc115b58ba2fb39abf6c2ddbd /doc/GIT.txt
parent7b33424c13455d9d5ec1958525ef1b2cbf8b4c90 (diff)
downloadngircd-248f8e0b7036b113e0d5a4b66f4b7d2db68a038f.tar.gz
ngircd-248f8e0b7036b113e0d5a4b66f4b7d2db68a038f.zip
Convert CVS commands to their git equivalents.
Also mention that patches should be sent to the mailing list.
Diffstat (limited to 'doc/GIT.txt')
-rw-r--r--doc/GIT.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/GIT.txt b/doc/GIT.txt
new file mode 100644
index 00000000..c42696d7
--- /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>.
+