From 1e8de05d953ee261e4e1fd4e900d0d093c0d9835 Mon Sep 17 00:00:00 2001 From: Martin Scheidt Date: Wed, 23 Mar 2022 22:07:13 +0100 Subject: [PATCH] Enhanced developement documentation --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8817478..8ae8272 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,13 @@ email, or any other method with the owners of this repository before making a ch Please note we have a code of conduct, please follow it in all your interactions with the project. +# Enhancing and developing the tikz-trackschematic library + +1. The tikz-trackschematic should be regularly installed via TeX Live to modify the library. The distributed package comes with a development switch. +2. Run the build script with `sudo ./build.sh --install-dev`. This will soft link the local files out of src folder into your TeX Live installation. +3. The TeX command `\usepackage[dev]{tikz-trackschematic}` will load the linked src folder instead of the distributed package from TeX Live. +4. After implementing your modification run `./build.sh --test` to check for any breaking changes. + # Pull Request Process 1. Ensure any install or build dependencies are removed before the end of the layer when doing a @@ -19,4 +26,4 @@ Please note we have a code of conduct, please follow it in all your interactions 5. The following versioning steps will be taken care of by the maintainer: 1. git repo with tag 2. CITATION.cff including DOI for current version - 3. sync Overleaf project \ No newline at end of file + 3. sync Overleaf project