aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGELOG.md13
-rw-r--r--INSTALL33
-rw-r--r--README21
-rw-r--r--config.mk2
4 files changed, 23 insertions, 46 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8669f81..7a15acf 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,17 +12,16 @@ this project _somewhat_ adheres to [Semantic Versioning].
UNRELEASED
--------------------------------------------------------------------------------
-### IMPORTANT
-- Switched to the `redo` build system.
-
### Added
-- Added basic installation instructions to an `INSTALL` file.
-- Added code coverage and unit tests using `shellspec`.
+- Added unit tests using `shellspec`.
+- Added support for `pax` for tarball extraction.
### Changed
+- Moved `cpt-lib` to `cpt-lib.in`.
- All `src` scripts now exit with success after being called with `--help`.
- Minor optimizations on `contrib` scripts.
-- Huge speed improvement on `cpt-export`
+- Huge speed improvement on `cpt-export`.
+- Updated the `getoptions` library to version `2.5.0`
### Fixed
- Fixed `cpt-cat` not using the `CPT_ROOT` value.
@@ -53,7 +52,7 @@ UNRELEASED
--------------------------------------------------------------------------------
### IMPORTANT
-- The `pkg_fixdeps()` function has been renmaed to `pkg_fix_deps()`.
+- The `pkg_fixdeps()` function has been renamed to `pkg_fix_deps()`.
- `cpt-lib` now parses options for you if `parser_definition()` is defined
before being called.
diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index 2a80450..0000000
--- a/INSTALL
+++ /dev/null
@@ -1,33 +0,0 @@
-Installation Instructions
-=========================
-
-In order to install cpt, you either need a redo implementation on your system,
-or use the `do` script inside the `tools/` directory (which is slower but the
-source code isn't that big anyways).
-
-Paths and version information can be configured from the `config.rc` file or
-through environment variables.
-
-
-Installing from a git checkout
-------------------------------
-
-On the git checkout of the repository, the info page for the package manager
-doesn't exist. The build system looks for `makeinfo` in order to build the info
-page, but exits with success if it isn't on your system. That's why you
-shouldn't edit the MAKEINFO variable even if you don't have it on your system,
-it is optional.
-
-
-With redo
----------
-
- redo
- DESTDIR= PREFIX=/usr/local redo install
-
-
-With minimal do
----------------
-
- ./tools/do
- DESTDIR= PREFIX=/usr/local ./tools/do install
diff --git a/README b/README
index c1021ad..202c68e 100644
--- a/README
+++ b/README
@@ -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
diff --git a/config.mk b/config.mk
index 482cf25..ce36661 100644
--- a/config.mk
+++ b/config.mk
@@ -19,5 +19,5 @@ DOCS = yes
# Files to be added into the distribution tarball
DISTFILES = contrib docs man spec src tests tools \
- .dir-locals.el CHANGELOG.md INSTALL LICENSE \
+ .dir-locals.el CHANGELOG.md LICENSE \
Makefile README config.mk cpt-base