Skip to content

Commit 1079f0b

Browse files
committed
README: add local test example, and CoC link.
1 parent 3c51a8b commit 1079f0b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,20 @@ source .env/bin/activate
5656
pip install circuitpython-build-tools
5757
circuitpython-build-bundles --filename_prefix <output file prefix> --library_location .
5858
```
59+
60+
When making changes to `circuitpython-build-tools` itself, you can test your changes
61+
locally like so:
62+
63+
```shell
64+
cd circuitpython-build-tools # this will be specific to your storage location
65+
python3 -m venv .env
66+
source .env/bin/activate
67+
pip install -e . # '-e' is pip's "development" install feature
68+
circuitpython-build-bundles --filename_prefix <output file prefix> --library_location <library location>
69+
```
70+
71+
## Contributing
72+
73+
Contributions are welcome! Please read our [Code of Conduct]
74+
(https://github.com/adafruit/Adafruit_CircuitPython_adabot/blob/master/CODE_OF_CONDUCT.md)
75+
before contributing to help this project stay welcoming.

0 commit comments

Comments
 (0)