From 4add8395488e6b54aa11461dd2a05afcc2452a89 Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Mon, 9 Dec 2024 06:05:09 -0500 Subject: [PATCH] Add instructions for running against customized TaskChampion (#3719) This is often useful when doing work that includes changes in both TC and TW. --- doc/devel/contrib/development.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/devel/contrib/development.md b/doc/devel/contrib/development.md index 0c9ae90bb..cfc6bce28 100644 --- a/doc/devel/contrib/development.md +++ b/doc/devel/contrib/development.md @@ -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" } +```