diff options
| author | merakor <cem@ckyln.com> | 2021-02-04 14:40:18 +0000 |
|---|---|---|
| committer | merakor <cem@ckyln.com> | 2021-02-04 14:40:18 +0000 |
| commit | 36299cf9b64f44ff1cbff6319d18e97d68cdf81c (patch) | |
| tree | 0e01e51641325c51a717fdbedcdefdc7c04a0de4 /README | |
| parent | 97312778a09decf65030e994e72ce07434ce0f07 (diff) | |
| download | cpt-36299cf9b64f44ff1cbff6319d18e97d68cdf81c.tar.gz | |
docs: update
FossilOrigin-Name: e1aaeb99cb71189c4b86cc28a1b3377a1787e0e534bc7b03b94a37344b7bd3c0
Diffstat (limited to 'README')
| -rw-r--r-- | README | 21 |
1 files changed, 16 insertions, 5 deletions
@@ -17,16 +17,27 @@ the `CHANGELOG.md` file. Dependencies -------------------------------------------------------------------------------- -To build and use cpt, you need the following software. +To build and use cpt, you need the following software: -RUNTIME DEPENDS - rsync - curl - POSIX base utilities [coreutils, busybox, sbase, etc.] -- tar [GNU tar, busybox, toybox, libarchive, etc.] +- pax or tar [GNU tar, busybox, toybox, libarchive, etc.] +- Common compression utilities such as gzip, bzip2, xz, etc. -MAKE DEPENDS -- redo (optional, the repository contains tools/do) + +In order to build the documentation, you will need the following software: + +- texinfo (for generating '.info' pages) +- Emacs (for generating '.texi' and '.txt' pages) + +However, distributed tarballs come with info pages, and '.texi' and '.txt' files +are committed directly into the repository, meaning that you don't need +`texinfo` if you are using a tarball, and you don't need Emacs as long as you +don't edit the documentation. + +You can also completely disable the build/installation of the documentation by +either passing `DOCS=no` to `make` or editing `config.mk` to disable it. Directory Structure |