-
Notifications
You must be signed in to change notification settings - Fork 23
/
README.md
59 lines (48 loc) · 2.46 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<!-- Referenced links -->
[bugs]: https://github.com/n-t-roff/heirloom-doctools/issues
[groff-ml]: https://lists.gnu.org/mailman/listinfo/groff
[homepage]: http://n-t-roff.github.io/heirloom/doctools.html
[releases]: https://github.com/n-t-roff/heirloom-doctools/releases
[Release-badge]: https://img.shields.io/github/v/release/n-t-roff/heirloom-doctools?label=latest%20release&color=brightGreen&sort=semver
[Release-link]: https://github.com/n-t-roff/heirloom-doctools/releases/latest
[Snapshot-badge]: https://img.shields.io/badge/download-ZIP%20archive-green
[Snapshot-link]: https://github.com/n-t-roff/heirloom-doctools/archive/refs/heads/master.zip
[HEAD-badge]: https://img.shields.io/github/last-commit/n-t-roff/heirloom-doctools?color=blue
[HEAD-link]: https://github.com/n-t-roff/heirloom-doctools/tree/HEAD
# Heirloom Doctools
[![Latest release][Release-badge]][Release-link]
[![Download ZIP][Snapshot-badge]][Snapshot-link]
[![Last commit][HEAD-badge]][HEAD-link]
For information about the Heirloom doctools please visit the project [homepage][].
Stable source-code versions are available from the [releases page][releases].
Development snapshots can be downloaded as a [ZIP archive][Snapshot-link] or with the command
<!-- XXX: HTML is used so readers can right-click the
hyperlink in their browsers and select "Copy URL" -->
<pre><code class="language-bash">git clone <a href=
"https://github.com/n-t-roff/heirloom-doctools.git"
>https://github.com/n-t-roff/heirloom-doctools.git</a>
</code></pre>
Installation paths and compiler settings are adjusted in `mk.config`.
The software is built with
```bash
./configure
make
```
and installed with
```bash
make install
```
To remove build artefacts and other generated files, run
```bash
make mrproper
```
Bugs can be reported at the [issue list][bugs].
Please wait before creating a patch or a pull-request,
since someone else could already be working on this issue or has a solution.
All ∗roff users are encouraged to subscribe to the GNU roff (groff)
[mailing list][groff-ml] for discussions and Heirloom doctools announcements.
Topics related to Heirloom should have a subject beginning with `[Heirloom]`.
However, please *don't* use the mailing-list to submit Heirloom bug-reports.
Instead, use the [issue tracker][bugs] mentioned above.
If there are any problems, please send an e-mail to:
<code>< <ins><b>troff</b></ins> [at] <ins><b>arcor</b></ins> [dot] <ins><b>de</b></ins> ></code>.