GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-08-28 04:27:20 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Documentation Update

Browse source 
- Removed 1.9.x references.
- Cleared out NEWS file.
This commit is contained in:
Paul Beckingham 2011-03-03 22:34:26 -05:00
parent 4de854a3c3
commit 589b84982f
5 changed files with 29 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

32
INSTALL
View file

@ -1,21 +1,20 @@
Installation Instructions
-------------------------
Building task with autotools has been phased out. As of version 1.9.4
task uses and builds now with cmake.
Please follow the instructions below to build task with cmake.
Pre-requisites
--------------
You will need the CMake build system installed in order to build taskwarrior
from source.
More information on cmake can be obtained at http://cmake.org
Optionally, you might want to have Lua installed, if you wish to write plugins
and modify taskwarrior.
More information on cmake can be obtained at http://cmake.org
Basic Installation
------------------
@ -49,20 +48,21 @@ These commands are explained below:
Build and configurations options
--------------------------------
You can customize the configuration run with cmake variables. This will modify the
installation process:
You can customize the configuration run with cmake variables. This will modify
the installation process:
To change the installation directory you use the following configuration variable:
To change the installation directory you use the following configuration
variable:
$ cmake -DCMAKE_INSTALL_PREFIX=<path-to-installation-dir> .
cmake configuration variables are applied with the -D option and consist of a <name>
and a <value>:
cmake configuration variables are applied with the -D option and consist of a
<name> and a <value>:
$ cmake -D<name>=<value> .
Four more variables can customize the installation process. The following table lists
them and their defaults plus the CMAKE_INSTALL_PREFIX:
Four more variables can customize the installation process. The following table
lists them and their defaults plus the CMAKE_INSTALL_PREFIX:
CMAKE_INSTALL_PREFIX /usr/local
TASK_BINDIR bin
@ -70,8 +70,8 @@ them and their defaults plus the CMAKE_INSTALL_PREFIX:
TASK_MAN1DIR share/man/man1
TASK_MAN5DIR share/man/man5
The correpsonding TASK_* variables will be combined with CMAKE_INSTALL_PREFIX to get
absolute installation directoris:
The corresponding TASK_* variables will be combined with CMAKE_INSTALL_PREFIX to
get absolute installation directoris:
CMAKE_INSTALL_PREFIZ/TASK_BINDIR /usr/local/bin
CMAKE_INSTALL_PREFIZ/TASK_DOCDIR /usr/local/share/doc/task
@ -92,9 +92,9 @@ step 7 above, they must first be regenerated by following steps [1], [2] and
Taskwarrior Build Notes
-----------------------
Taskwarrior 1.9.4 has dependencies that are detected by cmake in almost all cases,
but there are situations and operating systems that mean you will need to offer
a little help.
Taskwarrior has dependencies that are detected by cmake in almost all cases, but
there are situations and operating systems that mean you will need to offer a
little help.
If taskwarrior will not build on your system, first take a look at the Operating
System notes below. If this doesn't help, then go to the Troubleshooting