]> jfr.im git - irc/atheme/atheme.git/blob - GIT-Access.txt
Merge pull request #927 from runxiyu/master
[irc/atheme/atheme.git] / GIT-Access.txt
1 Downloading the Git repository
2 ------------------------------
3
4 Atheme's Git repository is available at the following address:
5 <https://github.com/atheme/atheme/>
6
7 If you have a modern version of Git (1.6.5 or newer), you can recursively
8 clone the repository:
9
10 $ git clone --recursive 'https://github.com/atheme/atheme/' atheme-devel
11 $ cd atheme-devel
12
13 If you have an older version of Git, you must clone the repository, and then
14 fetch its submodules:
15
16 $ git clone 'https://github.com/atheme/atheme/' atheme-devel
17 $ cd atheme-devel
18 $ git submodule init
19 $ git submodule update
20
21
22
23 Building from the Git repository
24 --------------------------------
25
26 If you have already checked out the Atheme Git repository, but you have
27 been instructed to read this file when configuring Atheme, then you did not
28 follow the advice above. Use the following commands to resolve the error:
29
30 $ git submodule init
31 $ git submodule update
32
33
34
35 Building from release tarballs
36 ------------------------------
37
38 If you did not obtain this software via Git, but received the GIT-Access.txt
39 error when configuring Atheme anyway, this means you downloaded the wrong
40 source archive.
41
42 When downloading releases from GitHub, you MUST use the *attached* archive:
43
44 atheme-7.x.x.tar.bz2 (or .tar.xz)
45
46 DO NOT use the "Download ZIP" button or the "Source code" links, as they are
47 missing the required submodules.