b189ccb020
This replaces the generation of man pages on project setup by a on-demand generation via asciidoctor. An exception are the man pages for the commands `day`, `month`, and `week` which are simply redirects to the man page `timew-chart.1`. Those are now static files in the Timewarrior repository. A CMake find module to detect asciidoctor was added. If asciidoctor is found, the targets `doc`, `man1`, and `man7` are created. Those targets are also added to the default build target. If asciidoctor is not available, the target `doc` is available, but it only emits a message to install asciidoctor first. Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com> |
||
|---|---|---|
| .github/workflows | ||
| cmake | ||
| completion | ||
| doc | ||
| ext | ||
| src | ||
| test | ||
| .gitignore | ||
| .gitmodules | ||
| AUTHORS | ||
| ChangeLog | ||
| cmake.h.in | ||
| CMakeLists.txt | ||
| commit.h.in | ||
| CONTRIBUTING.md | ||
| DCO | ||
| docker-compose.yml | ||
| INSTALL | ||
| LICENSE | ||
| README.md | ||
Timewarrior
Thank you for taking a look at Timewarrior!
Timewarrior is a time tracking utility that offers simple stopwatch features as well as sophisticated calendar-based backfill, along with flexible reporting. It is a portable, well supported and very active Open Source project.
Installing
From Package
Thanks to the community, there are binary packages available here.
Building Timewarrior
Building Timewarrior yourself requires
- git
- cmake
- make
- C++ compiler, currently gcc 4.8.1+ or clang 3.3+ for full C++11 support
- Python 3, for running the testsuite
There are two ways to retrieve the Timewarrior sources:
-
Clone the repository from Github,
git clone --recurse-submodules https://github.com/GothenburgBitFactory/timewarrior cd timewarrior -
Or download the tarball with curl,
curl -O https://github.com/GothenburgBitFactory/timewarrior/releases/download/v1.4.2/timew-1.4.2.tar.gzand expand the tarball
tar xzf timew-1.4.2.tar.gz cd timew-1.4.2
Build Timewarrior, optionally run the test suite (note: the tarball does not contain tests), and install it.
cmake -DCMAKE_BUILD_TYPE=release
make
[make test]
sudo make install
This copies files into the right place (default under /usr/local), and installs man pages.
Add the optional parameter -DCMAKE_INSTALL_PREFIX=/path/to/your/install/location to the cmake command if you want to install Timewarrior at a location other than /usr/local.
The make install command may not require sudo depending on your choice of install location.
Documentation
There is extensive online documentation. You'll find all the details at timewarrior.net/docs/.
There you will find the documentation, downloads, news and more.
Contributing
Your contributions are especially welcome. Whether it comes in the form of code patches, ideas, discussion, bug reports, encouragement or criticism, your input is needed.
For support options, take a look at CONTRIBUTING.md or visit taskwarrior.org.
Visit Github and participate in the future of Timewarrior.
License
Timewarrior is released under the MIT license. For details check the LICENSE file.