mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-06-26 10:54:26 +02:00
2d4776586d
The commit count has been inacurrate for some time, undercounting (perhaps due to aggreessive caching), but also overcounting at times (due to merges).
132 lines
6.7 KiB
Markdown
132 lines
6.7 KiB
Markdown
<div align="center">
|
|
<img src="https://avatars.githubusercontent.com/u/36100920?s=200&u=24da05914c20c4ccfe8485310f7b83049407fa9a&v=4"></br>
|
|
|
|
[](https://github.com/GothenburgBitFactory/taskwarrior/actions)
|
|
[](https://github.com/GothenburgBitFactory/taskwarrior/releases/latest)
|
|
[](https://github.com/GothenburgBitFactory/taskwarrior/releases/latest)
|
|
[](https://github.com/sponsors/GothenburgBitFactory/)
|
|
</br>
|
|
[](https://twitter.com/taskwarrior)
|
|
</div>
|
|
|
|
## Taskwarrior
|
|
|
|
|
|
|
|
|
|
Taskwarrior is a command line task list management utility with a [multitude of
|
|
features](https://taskwarrior.org/docs/), developed as a portable open source project
|
|
with an active and quite vast [ecosystem of tools, hooks and
|
|
extensions](https://taskwarrior.org/tools/).
|
|
|
|
## Install
|
|
[](https://archlinux.org/packages/community/x86_64/task/)
|
|
[](https://packages.debian.org/search?keywords=task&searchon=names&suite=all§ion=all)
|
|
[](https://bodhi.fedoraproject.org/updates/?packages=task)
|
|
[](https://formulae.brew.sh/formula/task#default)
|
|
[](https://packages.ubuntu.com/search?keywords=task&searchon=names&suite=hirsute§ion=all)
|
|
|
|
Taskwarrior is packaged on a wide range of [Linux/Unix systems, Mac OS and
|
|
Windows](https://taskwarrior.org/download/). Check out the latest available
|
|
packages in repositories of your OS distribution of choice [on
|
|
Repology](https://repology.org/project/taskwarrior/versions).
|
|
|
|
Alternatively, you can build Taskwarrior from source.
|
|
|
|
## Documentation
|
|
|
|
The [online documentation](https://taskwarrior.org/docs), downloads, news and
|
|
more are available on our website, [taskwarrior.org](https://taskwarrior.org).
|
|
|
|
We also recommend following [@taskwarrior on
|
|
Twitter](https://twitter.com/taskwarrior), where we share info about new
|
|
features, releases and various tips and tricks for new Taskwarrior users.
|
|
|
|
## Community
|
|
[](https://twitter.com/taskwarrior)
|
|
[](https://reddit.com/r/taskwarrior/)
|
|
[](https://web.libera.chat/#taskwarrior)
|
|
[](https://discord.gg/eRXEHk8w62)
|
|
[](https://github.com/GothenburgBitFactory/taskwarrior/discussions)
|
|
|
|
Taskwarrior has a lively community on many places on the internet.
|
|
|
|
Best place to ask questions is our [discussions forum on
|
|
Github](https://github.com/GothenburgBitFactory/taskwarrior/discussions). For
|
|
other support options, take a look at
|
|
[taskwarrior.org/support](https://taskwarrior.org/support)
|
|
|
|
For code contributions, please use pull requests, or alternately send your code patches to
|
|
[support@gothenburgbitfactory.org](mailto:support@gothenburgbitfactory.org)
|
|
|
|
## Branching Model
|
|
|
|
We use the following branching model:
|
|
|
|
* `stable` is a branch containing the content of the latest release. Building
|
|
from here is the same as building from the latest tarball, or installing a
|
|
binary package. No development is done on the `stable` branch.
|
|
|
|
* `develop` is the current development branch. All work is done here, and upon
|
|
release it will be merged to `stable`. While development branch is not
|
|
stable, we utilize CI to ensure we're at least not merging improvements that
|
|
break existing tests, and hence should be relatively safe. We still recommend
|
|
making backups when using the development branch.
|
|
|
|
## Installing
|
|
|
|
There are many binary packages available, but to install from source requires:
|
|
|
|
* git
|
|
* cmake
|
|
* make
|
|
* C++ compiler, currently gcc 7.1+ or clang 5.0+ for full C++17 support
|
|
* libuuid
|
|
* GnuTLS (optional, required for sync)
|
|
|
|
Download the tarball, and expand it:
|
|
|
|
$ curl -O https://taskwarrior.org/download/task-2.6.1.tar.gz
|
|
$ tar xzf task-2.6.1.tar.gz
|
|
$ cd task-2.6.1
|
|
|
|
Or clone this repository:
|
|
|
|
$ git clone --recursive -b stable https://github.com/GothenburgBitFactory/taskwarrior.git
|
|
$ cd taskwarrior
|
|
|
|
Then build:
|
|
|
|
$ cmake -DCMAKE_BUILD_TYPE=release .
|
|
...
|
|
$ make
|
|
...
|
|
[$ make test]
|
|
...
|
|
$ sudo make install
|
|
|
|
## Contributing
|
|
[](https://github.com/GothenburgBitFactory/taskwarrior/graphs/contributors)
|
|
[](https://github.com/GothenburgBitFactory/taskwarrior/milestone/26)
|
|
[](https://github.com/GothenburgBitFactory/taskwarrior/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
|
|
|
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.
|
|
|
|
Visit [Github](https://github.com/GothenburgBitFactory/taskwarrior) and participate in the future of Taskwarrior.
|
|
|
|
## Sponsoring
|
|
[](https://github.com/sponsors/GothenburgBitFactory/)
|
|
|
|
Taskwarrior is a result of work of mostly small group of volunteers, and has been in development since 2006.
|
|
|
|
If you are a happy Taskwarrior user, please consider [sponsoring us through
|
|
Github Sponsors](https://github.com/sponsors/GothenburgBitFactory/).
|
|
|
|
Every sponsorship matters, as it directly increases the number of hours core
|
|
developers can contribute to the project and makes the project more sustainable.
|
|
|
|
## License
|
|
|
|
Taskwarrior is released under the MIT license.
|
|
For details check the [LICENSE](LICENSE) file.
|