Streamline ".gitignore" files
[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, an distributed version
13 control system. Homepage including documentation: <http://git-scm.com/>.
14
15
16 I. Viewing the source code online
17 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18
19 The ngIRCd "GITweb" interface allows you to browse the GIT repository and
20 to see all individual files, tags, branches, commits etc.:
21
22  <http://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git>
23
24
25 II. Getting the source code
26 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
27
28 To access (copy, clone) the source tree repository anonymously, run:
29
30  $ git clone git://ngircd.barton.de/ngircd.git
31
32 Thereby a new folder "ngircd" will be created containing all the individual
33 source files.
34
35 The newly created directory ("ngircd") is the "working directory", all
36 GIT commands will be executed from within this directory in the future.
37
38 Please note: When checking out a fresh copy of ngIRCd using GIT, the
39 configure script doesn't exist; you have to run the autogen.sh shell script
40 (which is included in the source tree) to generate it. This requires you to
41 have GNU automake and GNU autoconf installed on your system. Please see the
42 file INSTALL for details!
43
44 To update the local GIT repository:
45
46  $ git pull
47
48 This retrieves all changes and merges them into the current branch.
49
50
51 III. Contributing
52 ~~~~~~~~~~~~~~~~~
53
54 Patches should be sent to the ngircd mailing list. List homepage:
55 http://arthur.barton.de/mailman/listinfo/ngircd-ml
56
57 If you do not want to send them to the list, you can also mail them
58 to Alex Barton, <alex@barton.de>.
59
60
61 IV. Write Access
62 ~~~~~~~~~~~~~~~~
63
64 If you want to contribute a couple of patches and write access to the GIT
65 repository would be handy, please contact Alex Barton, <alex@barton.de>.