Add instructions for running against customized TaskChampion (#3719)

This is often useful when doing work that includes changes in both TC
and TW.
This commit is contained in:
Dustin J. Mitchell 2024-12-09 06:05:09 -05:00 committed by GitHub
parent 3ea726f2bb
commit 4add839548
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -94,3 +94,13 @@ They can be found in the [ctest](https://cmake.org/cmake/help/latest/manual/ctes
Note that any development should be performed using a git clone, and the current development branch.
The source tarballs do not reflect HEAD, and do not contain the test suite.
Follow the [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) for creating a pull request.
## Using a Custom Version of TaskChampion
To build against a different version of Taskchampion, modify the requirement in `src/taskchampion-cpp/Cargo.toml`.
To build from a local checkout, replace the version with a [path dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies), giving the path to the directory containing TaskChampion's `Cargo.toml`:
```toml
taskchampion = { path = "path/to/taskchampion" }
```