From e64d6683b8817572dbd3758593ea69d0d1e582f9 Mon Sep 17 00:00:00 2001 From: Andrea Settimi Date: Fri, 19 Apr 2024 16:53:27 +0200 Subject: [PATCH] ADD-FIX: missing isntructions for package --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6121378f..ce35943e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,6 +77,11 @@ C:\Users\\.rhinocode\py39-rh8\site-envs\default-wMh5LZL3 ``` > note that if you drop an official released diffCheck component from yak, this one will have the `#r : diffCheck==` notation at the top of the script. Get rid of all these release components before to start and be sur to erase again the previous folders (they recreated each time `#r : diffCheck` is called). +Build the package from the py source code's directory: +```py +python setup.py sdist bdist_wheel +``` + Lastly, install the pip pacakge from the repository in editable mode. This way, all the modifications made to the source code of the repository will be reflected in the installed package. Open a terminal and run the following command (replace the path with where you download the repository): ```terminal C:\Users\\.rhinocode\py39-rh8\python.exe -m pip install -e "\src\gh\diffCheck"