]> arthur.barton.de Git - ngircd-alex.git/blob - doc/GIT.txt
Update doc/GIT.txt
[ngircd-alex.git] / doc / GIT.txt
1
2                      ngIRCd - Next Generation IRC Server
3                            http://ngircd.barton.de/
4
5                (c)2001-2011 Alexander Barton and Contributors.
6                ngIRCd is free software and published under the
7                    terms of the GNU General Public License.
8
9                                  -- GIT.txt --
10
11
12 The source code of ngIRCd is maintained using git, the stupid content
13 tracker.
14
15
16 I. Getting the source code
17 ~~~~~~~~~~~~~~~~~~~~~~~~~~
18 To access the source tree anonymously, run:
19
20  $ git clone git://ngircd.barton.de/ngircd.git
21
22 Thereby a new folder "ngircd" will be created containing all the individual
23 source files.
24
25 The newly created directory ("ngircd") is the "working directory", all
26 git commands will be executed from within this directory in the future.
27
28 Please note: When checking out a fresh copy of ngIRCd using git, the
29 configure script doesn't exist; you have to run the autogen.sh shell script
30 (which is included in the source tree) to generate it. This requires you to
31 have GNU automake and GNU autoconf installed on your system. Please see the
32 file INSTALL for details!
33
34 To update the git tree:
35
36  $ git pull
37
38 This retrieves all changes and merges them into the current branch.
39
40
41 II. Contributing
42 ~~~~~~~~~~~~~~~~
43
44 Patches should be sent to the ngircd mailing list. List homepage:
45 http://arthur.barton.de/mailman/listinfo/ngircd-ml
46
47 If you do not want to send them to the list, you can also mail them
48 to Alex Barton, <alex@barton.de>.
49
50
51 III. Write Access
52 ~~~~~~~~~~~~~~~~~
53 If you want to contribute a couple of patches and write access to the git
54 repository would be handy, please contact Alex Barton, <alex@barton.de>.