[READ-ONLY] Mirror of https://github.com/VibeDevelopers/atheme. Modified fork of atheme IRC Services
www.vibetalk.net/
README.md, GIT-Access.txt: Some small improvements
- Recommend an explicit directory name for the clone, to avoid cloning
into ~/atheme/ if the user runs the `git clone` operation in their
home directory. Atheme defaults to installing to ~/atheme/, and you
cannot install Atheme to its source directory. [1]
- Recommend the use of the `--recursive` option to `git clone` in
`README.md`, as it was already recommended in `GIT-Access.txt`. [1]
- Provide alternative command sequences for people who have very old
versions of git, which may not even support the `--init` option of
`git submodule update`, let alone the `--recursive` option of
`git clone`.
- Quote a filesystem path.
- Tidy up the more information section in the bottom of `README.md`.
[1] Suggested by GitHub user @PeGaSuS-Coder in PR #764
Closes #764
Aaron Jones
(Feb 21, 2021, 11:23 PM UTC)
ef9b4dfd
f22b8f34
+69
-37
+33
-14
GIT-Access.txt
+33
-14
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
+
1
23
Building from the Git repository
2
24
--------------------------------
3
25
4
26
If you have already checked out the Atheme Git repository, but you have
5
-
been instructed to read this file when configuring atheme, then use the
6
-
following command to resolve the error:
7
-
$ git submodule update --init --recursive
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:
8
29
9
-
The Atheme Git repository can be checked out using the following command:
10
-
$ git clone --recursive 'https://github.com/atheme/atheme.git' atheme-devel
11
-
$ cd atheme-devel
12
-
13
-
Atheme's Git repository depot can be browsed over the internet at the
14
-
following address: <https://github.com/atheme/atheme/>
30
+
$ git submodule init
31
+
$ git submodule update
15
32
16
33
17
34
18
35
Building from release tarballs
19
36
------------------------------
20
37
21
-
If you did not use Git, but received the GIT-Access.txt error anyway, this
22
-
means you downloaded the wrong source archive.
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.
23
41
24
-
When downloading releases from GitHub, you MUST use the attached archive:
42
+
When downloading releases from GitHub, you MUST use the *attached* archive:
25
43
26
-
atheme-7.x.x.tar.bz2
44
+
atheme-7.x.x.tar.bz2 (or .tar.xz)
27
45
28
-
DO NOT use the "Source code (tar.gz)" links, as they're missing submodules.
46
+
DO NOT use the "Download ZIP" button or the "Source code" links, as they are
47
+
missing the required submodules.
+36
-23
README.md
+36
-23
README.md
···
12
12
13
13
## Obtaining Atheme
14
14
15
-
You can either git clone `https://github.com/atheme/atheme.git` or download a
16
-
package via our website at `https://atheme.github.io/` -- Please do not click
17
-
the "Download" buttons on GitHub as they lack needed submodules, etc.
15
+
If you have a modern version of Git (1.6.5 or newer), you can recursively
16
+
clone the repository:
18
17
19
-
If you are running this code from Git, you should read GIT-Access.txt for
20
-
instructions on how to fully check out the atheme tree, as it is spread
21
-
across many repositories.
18
+
$ git clone --recursive 'https://github.com/atheme/atheme/' atheme-devel
19
+
$ cd atheme-devel
20
+
21
+
If you have an older version of Git, you must clone the repository, and then
22
+
fetch its submodules:
23
+
24
+
$ git clone 'https://github.com/atheme/atheme/' atheme-devel
25
+
$ cd atheme-devel
26
+
$ git submodule init
27
+
$ git submodule update
28
+
29
+
If you don't have Git, you can download a package archive from our website at
30
+
<https://atheme.github.io/>.
31
+
32
+
If you are browsing our GitHub repository, please do NOT click the "Download
33
+
ZIP" button or the "Source code" links there, as they will give you an archive
34
+
that lacks the required submodules. There are proper `.tar.bz2` or `.tar.xz`
35
+
archives attached to each release under "Assets", which is what the "Download"
36
+
button on our website will take you to.
22
37
23
38
24
39
25
40
## Basic build instructions for the impatient
26
41
27
-
Whatever you do, make sure you do *not* install Atheme into the same location
28
-
as the source. Atheme will default to installing in `$HOME/atheme`, so make
29
-
sure you plan accordingly for this.
42
+
Obtain the source code repository and change into its directory (using the
43
+
commands given above).
30
44
31
-
$ git submodule update --init
45
+
If you are building Atheme on a GNU/Linux system, or something which can
46
+
sufficiently emulate that (like WSL 2 on Windows 10), execute the following
47
+
commands:
48
+
32
49
$ ./configure
33
50
$ make
34
51
$ make install
35
52
36
-
If you are on an OpenBSD system, or similar, you will need to do things
37
-
slightly differently:
53
+
If you are building Atheme on an OpenBSD (or similar) system, execute the
54
+
following commands instead:
38
55
39
56
# pkg_add gmake
40
-
$ git submodule update --init
41
57
$ ./configure --disable-linker-defs
42
58
$ gmake
43
59
$ gmake install
···
47
63
## Library Detection
48
64
49
65
If your user-installed libraries that you want Atheme to use are installed by
50
-
your package manager to a directory such as /usr/local/, you may need to
66
+
your package manager to a directory such as `/usr/local/`, you may need to
51
67
supplement the default compiler and linker search paths so that Atheme can
52
68
detect those libraries (e.g. cracklib from FreeBSD Ports):
53
69
···
114
130
115
131
## Getting More Help
116
132
117
-
If you're still lost, read the [INSTALL](INSTALL) or
118
-
[GIT-Access.txt](GIT-Access.txt) files or check out our wiki
119
-
(http://github.com/atheme/atheme/wiki) for more hints.
133
+
If you're still lost, read the [INSTALL](INSTALL) file or check out our wiki
134
+
for more hints.
120
135
121
-
See also:
122
-
123
-
* [GitHub](https://github.com/atheme/atheme)
124
-
* [Website](http://atheme.github.io/)
125
-
* [Wiki](https://github.com/atheme/atheme/wiki)
126
-
* [Freenode / #atheme](ircs://chat.freenode.net:6697/#atheme)
136
+
- [Our Website](https://atheme.github.io/)
137
+
- [Our GitHub Repository](https://github.com/atheme/atheme/)
138
+
- [The Atheme Wiki](https://github.com/atheme/atheme/wiki/)
139
+
- [The #atheme channel on freenode](ircs://chat.freenode.net:6697/#atheme)