mirror of
https://github.com/GothenburgBitFactory/taskshell.git
synced 2025-08-18 15:33:12 +02:00
Docs: Updated in preparation for release
This commit is contained in:
parent
bd7162f58d
commit
b0e8dfa290
2 changed files with 24 additions and 23 deletions
26
INSTALL
26
INSTALL
|
@ -1,11 +1,11 @@
|
||||||
Installation Instructions
|
Installation Instructions
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
Please follow the instructions below to build tasksh with cmake.
|
Please follow the instructions below to build and install tasksh from source.
|
||||||
|
|
||||||
|
|
||||||
Pre-requisites
|
Dependencies
|
||||||
--------------
|
------------
|
||||||
|
|
||||||
You will need the CMake build system installed in order to build tasksh from
|
You will need the CMake build system installed in order to build tasksh from
|
||||||
source. Information on cmake can be obtained at http://cmake.org
|
source. Information on cmake can be obtained at http://cmake.org
|
||||||
|
@ -18,11 +18,11 @@ Additionally, you will need:
|
||||||
Basic Installation
|
Basic Installation
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
Briefly, these shell commands will unpack, build and install taskwarrior:
|
Briefly, these shell commands will unpack, build and install Tasksh:
|
||||||
|
|
||||||
$ tar xzf tasksh-X.Y.Z.tar.gz [1]
|
$ tar xzf tasksh-X.Y.Z.tar.gz [1]
|
||||||
$ cd tasksh-X.Y.Z [2]
|
$ cd tasksh-X.Y.Z [2]
|
||||||
$ cmake . [3]
|
$ cmake -DCMAKE_BUILD_TYPE=release . [3]
|
||||||
$ make [4]
|
$ make [4]
|
||||||
$ sudo make install [5]
|
$ sudo make install [5]
|
||||||
$ cd .. ; rm -r tasksh-X.Y.Z [6]
|
$ cd .. ; rm -r tasksh-X.Y.Z [6]
|
||||||
|
@ -35,7 +35,8 @@ These commands are explained below:
|
||||||
2. Change directory to the root of the distribution.
|
2. Change directory to the root of the distribution.
|
||||||
|
|
||||||
3. Invokes CMake to scan for dependencies and machine-specific details, then
|
3. Invokes CMake to scan for dependencies and machine-specific details, then
|
||||||
generate the makefiles. This may take a minute.
|
generate the makefiles. Requests an optimized build, which will run faster
|
||||||
|
and be more compact. This may take a minute.
|
||||||
|
|
||||||
4. Builds tasksh. This may take a minute.
|
4. Builds tasksh. This may take a minute.
|
||||||
|
|
||||||
|
@ -79,17 +80,20 @@ get absolute installation directories:
|
||||||
Uninstallation
|
Uninstallation
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
To uninstall tasksh, you need the Makefiles, so if you deleted them in
|
There is no uninstall option in CMake makefiles. This is a manual process.
|
||||||
step 7 above, they must first be regenerated by following steps [1], [2] and
|
|
||||||
[3]. Then simply run:
|
|
||||||
|
|
||||||
$ sudo make uninstall TODO TODO TODO -- cmake doesn't include uninstall
|
To uninstall Tasksh, remove the files listed in the install_manifest.txt file
|
||||||
|
that was generated when you built Tasksh.
|
||||||
|
|
||||||
|
|
||||||
Tasksh Build Notes
|
Tasksh Build Notes
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
If tashsh will not build on your system, first take a look at the Operating
|
Tasksh 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 Tasksh 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
|
System notes below. If this doesn't help, then go to the Troubleshooting
|
||||||
section, which includes instructions on how to contact us for help.
|
section, which includes instructions on how to contact us for help.
|
||||||
|
|
||||||
|
|
21
NEWS
21
NEWS
|
@ -1,7 +1,7 @@
|
||||||
|
|
||||||
New Features in tasksh 1.1.0
|
New Features in tasksh 1.1.0
|
||||||
|
|
||||||
- Review support
|
- Support for a GTD-like review session.
|
||||||
|
|
||||||
New commands in tasksh 1.1.0
|
New commands in tasksh 1.1.0
|
||||||
|
|
||||||
|
@ -10,19 +10,16 @@ New commands in tasksh 1.1.0
|
||||||
|
|
||||||
New configuration options in tasksh 1.1.0
|
New configuration options in tasksh 1.1.0
|
||||||
|
|
||||||
- None
|
- The 'tasksh.autoclear' setting in Taskwarrior is used by Tasksh to clear
|
||||||
|
the terminal before every command, if set to '1'.
|
||||||
Newly deprecated features in tasksh 1.1.0
|
|
||||||
|
|
||||||
- None
|
|
||||||
|
|
||||||
Removed features in 1.1.0
|
|
||||||
|
|
||||||
- None
|
|
||||||
|
|
||||||
Known Issues
|
Known Issues
|
||||||
|
|
||||||
- None
|
- Spaces in project names in tasksh
|
||||||
|
https://bug.tasktools.org/browse/TS-3
|
||||||
|
|
||||||
|
- Tasksh throws errors on unescaped parentheses
|
||||||
|
https://bug.tasktools.org/browse/TS-23
|
||||||
|
|
||||||
Tasksh has been built and tested on the following configurations:
|
Tasksh has been built and tested on the following configurations:
|
||||||
|
|
||||||
|
@ -30,7 +27,7 @@ Tasksh has been built and tested on the following configurations:
|
||||||
* Fedora
|
* Fedora
|
||||||
* Ubuntu
|
* Ubuntu
|
||||||
* Debian
|
* Debian
|
||||||
* Arch Linux
|
* Arch
|
||||||
* FreeBSD
|
* FreeBSD
|
||||||
* Cygwin
|
* Cygwin
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue