From f9fd819c0d42b42ec89eeda65ecd4e84cc47800e Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Thu, 17 Dec 2015 14:20:28 +0100 Subject: add install and news MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- INSTALL | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ NEWS | 6 +++++ 2 files changed, 88 insertions(+) create mode 100644 INSTALL create mode 100644 NEWS diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..f9a21b2 --- /dev/null +++ b/INSTALL @@ -0,0 +1,82 @@ +Type './configure --help' for configuration options. The normal settings for a +GNU package should work. If not, please make a bug report. + + On a common GNU/Linux distribution the following should + be sufficient for most users: + + ./configure --prefix=/usr + make + make install DESTDIR="somewhere you want the files for now" + # Now let the package manager put the files in place... + + Or for an unstaged install: + + ./configure --prefix=/usr + make + sudo make install + +By default any applicable pre-install, post-install, pre-uninstall, and +post-install commands is run. This suppress these, run 'make' with 'N=true' +or 'N=:'. IF you want to know which these commands are, you can use the +methods specificed in the GNU Coding Standards. Another method is found in +mk/README. However, for this packages, these will be: + + infodir="usr/local/share/info" ## Assuming default prefix. + + post_install () { + install-info -- "${infodir}/vtchs.info" "${infodir}/dir" + } + + pre_uninstall () { + install-info --delete -- "${infodir}/vtchs.info" "${infodir}/dir" + } + + +──────────────────────────────────────────────────────────────────────────────── +CUSTOMISED COMPILATION +──────────────────────────────────────────────────────────────────────────────── + +The makefile is configured to compile the C code with -O2 -g, you can +change this by setting OPTIMISE, or with CFLAGS and LDFLAGS if you want +to change all optional flags compiling and linking flags: + + ./configure OPTIMISE="-Og -g" + + +──────────────────────────────────────────────────────────────────────────────── +CUSTOMISED INSTALLATION +──────────────────────────────────────────────────────────────────────────────── + +If you want to install absolutely everything, you can +instead use the commands below: + + make everything + make install-everything DESTDIR="pkg" + +Or if you only want to absolute basics: + + make base + make install-base DESTDIR="pkg" + +You can select freely what parts of the package to install and not +to install. This rules are available: + +┌─────────────┬─────────────────────┬────────────────────────────────────────────┐ +│ COMPILATION │ INSTALLATION │ DESCRIPTION │ +├─────────────┼─────────────────────┼────────────────────────────────────────────┤ +│ base │ install-base │ Install be basics: │ +│ cmd │ install-cmd │ Install the vtchs command. │ +│ │ install-copyright │ Install license file. │ +│ doc │ install-doc │ Include all manuals: │ +│ info │ install-info │ Include info manual. (Texinfo) │ +│ dvi │ install-dvi │ Include DVI manual. (Texinfo) │ +│ pdf │ install-pdf │ Include PDF manual. (Texinfo) │ +│ ps │ install-ps │ Include PostScript manual. (Texinfo) │ +│ html │ install-html │ Include multifile HTML manual. (Texinfo) │ +│ │ install-man │ Include man pages. │ +└─────────────┴─────────────────────┴────────────────────────────────────────────┘ + +install, install-everything, install-base, and install-cmd, have alternatives +that installs a stripped binary: install-strip, install-everything-strip, +install-base-strip, and install-cmd-strip, respectively. + diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..801b7c4 --- /dev/null +++ b/NEWS @@ -0,0 +1,6 @@ +vtchs NEWS -*- outline -*- + +* Noteworthy changes in release 1.0 (2014-(12)Dec-17 UTC) [stable] + + Initial release. + -- cgit v1.2.3-70-g09d2