mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-07-07 20:06:36 +02:00
31 lines
1.6 KiB
Markdown
31 lines
1.6 KiB
Markdown
TaskChampion
|
|
------------
|
|
|
|
TaskChampion is an open-source personal task-tracking application.
|
|
Use it to keep track of what you need to do, with a quick command-line interface and flexible sorting and filtering.
|
|
It is modeled on [TaskWarrior](https://taskwarrior.org), but not a drop-in replacement for that application.
|
|
|
|
See the [documentation](https://taskchampion.github.io/taskchampion/) for more!
|
|
|
|
## Status
|
|
|
|
TaskChampion currently functions as a "testbed" for new functionality that may later be incorporated into TaskWarrior.
|
|
It can be developed without the requirements of compatibliity, allowing us to explore and fix edge-cases in things like the replica-synchronization model.
|
|
|
|
While you are welcome to [help out](https://github.com/taskchampion/taskchampion/blob/main/CONTRIBUTING.md), you should do so with the awareness that your work might never be used.
|
|
But, if you just want to get some practice with Rust, we'd be happy to have you.
|
|
|
|
## Structure
|
|
|
|
There are four crates here:
|
|
|
|
* [taskchampion](./taskchampion) - the core of the tool
|
|
* [taskchampion-cli](./cli) - the command-line binary
|
|
* [taskchampion-sync-server](./sync-server) - the server against which `task sync` operates
|
|
* [replica-server-tests](./replica-server-tests) - integration tests covering both _taskchampion-cli_ and _taskchampion-sync-server_
|
|
|
|
## Documentation Generation
|
|
|
|
The `mdbook` configuration contains a "preprocessor" implemented in the `taskchampion-cli` crate in order to reflect CLI usage information into the generated book.
|
|
Tihs preprocessor is not built by default.
|
|
To (re)build it, run `cargo build -p taskchampion-cli --features usage-docs --bin usage-docs`.
|