README.md
1# Timewarrior
2
3[](https://github.com/GothenburgBitFactory/timewarrior/actions/workflows/tests.yaml)
4
5Thank you for taking a look at Timewarrior!
6
7Timewarrior is a time tracking utility that offers simple stopwatch features as well as sophisticated calendar-based backfill, along with flexible reporting.
8It is a portable, well supported and very active Open Source project.
9
10## Installing
11
12### From Package
13
14Thanks to the community, there are binary packages available [here](https://timewarrior.net/docs/install.html#distributions).
15
16### Building Timewarrior
17
18Building Timewarrior yourself requires
19
20* git
21* cmake
22* make
23* C++ compiler with full C++14 support, currently gcc 6.1+ or clang 3.4+
24* Python 3 (for running the testsuite)
25* Asciidoctor (for creating documentation)
26
27There are two ways to retrieve the Timewarrior sources:
28
29* Clone the repository from Github,
30
31 git clone --recurse-submodules https://github.com/GothenburgBitFactory/timewarrior
32 cd timewarrior
33
34* Or download the tarball with curl,
35
36 curl -O https://github.com/GothenburgBitFactory/timewarrior/releases/download/v1.4.3/timew-1.4.3.tar.gz
37
38 and expand the tarball
39
40 tar xzf timew-1.4.3.tar.gz
41 cd timew-1.4.3
42
43Build Timewarrior, optionally run the test suite, and install it.
44
45 cmake -DCMAKE_BUILD_TYPE=release
46 make
47 [make test]
48 sudo make install
49
50This copies files into the right place (default under `/usr/local`), and installs man pages.
51
52Add 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`.
53The `make install` command may not require `sudo` depending on your choice of install location.
54
55## Documentation
56
57There is extensive online documentation.
58You'll find all the details at [timewarrior.net/docs/](https://timewarrior.net/docs/).
59
60There you will find the documentation, downloads, news and more.
61
62## Contributing
63
64Your contributions are especially welcome.
65Whether it comes in the form of code patches, ideas, discussion, bug reports, encouragement or criticism, your input is needed.
66
67For support options, take a look at [CONTRIBUTING.md](CONTRIBUTING.md) or visit [taskwarrior.org](https://taskwarrior.org/support).
68
69Visit [Github](https://github.com/GothenburgBitFactory/timewarrior) and participate in the future of Timewarrior.
70
71## License
72
73Timewarrior is released under the MIT license.
74For details check the [LICENSE](LICENSE) file.
75
){kind=link}