ae06f0526a
5.8 KiB
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.
Please visit timewarrior.net for extensive documentation, downloads, news and more.
Installing
From Package
Thanks to the community, there are binary packages available here.
Building Timewarrior
Building Timewarrior yourself requires
- Git
- CMake (>= 3.8)
- Make
- C++ compiler with full C++17 support, currently GCC 8+ or Clang 5+
- Python 3 (for running the testsuite)
- Asciidoctor (for creating documentation)
There are two ways to retrieve the Timewarrior sources:
- Clone the repository from GitHub and update required submodules,
git clone --recurse-submodules https://github.com/GothenburgBitFactory/timewarrior cd timewarrior - Or download the tarball with curl,
and expand the tarballcurl -O https://github.com/GothenburgBitFactory/timewarrior/releases/download/v1.8.0/timew-1.8.0.tar.gztar xzf timew-1.8.0.tar.gz cd timew-1.8.0
Build Timewarrior, optionally run the test suite, 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.
Community
Timewarrior has a lively community on many places on the internet. The project has its own Twitter account, and shares community spaces on IRC and Discord with Taskwarrior.
Best place to ask questions is our discussions forum on GitHub. For other support options, take a look at timewarrior.net/support
Contributing
Contributions are greatly appreciated. Whether in the form of code patches, ideas, discussion, bug reports, encouragement or criticism, we need you!
For support options, take a look at CONTRIBUTING.md or visit timewarrior.net.
Visit GitHub and participate in the future of Timewarrior.
License
Timewarrior is released under the MIT license. For details check the LICENSE file.