Skip to content

Latest commit

 

History

History
103 lines (80 loc) · 5.8 KB

README.md

File metadata and controls

103 lines (80 loc) · 5.8 KB
Raw
Timewarrior logo

Tests Release Release date Commits since release
Twitter

Timewarrior

macOS downloads GitHub downloads Linux downloads

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

Arch Linux Debian Fedora Homebrew Ubuntu

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, 
    curl -O https://github.com/GothenburgBitFactory/timewarrior/releases/download/v1.7.1/timew-1.7.1.tar.gz
    and expand the tarball 
    tar xzf timew-1.7.1.tar.gz
cd timew-1.7.1

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

Twitter Reddit Libera.chat Discord GitHub discussions

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

Contributors Milestone progress Good first issues

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 timewarior.net.

Visit GitHub and participate in the future of Timewarrior.

License

Timewarrior is released under the MIT license. For details check the LICENSE file.