Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
[submodule "circuitpython"]
path = circuitpython
url = https://github.com/adafruit/circuitpython
[submodule "libraries/register"]
path = libraries/helpers/register
url = https://github.com/adafruit/Adafruit_CircuitPython_Register.git
Expand Down
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Determine the best location within `libraries` for the new library and then run:

git submodule add <git url> libraries/<target directory>

The target directory should omit any MicroPython or CircuitPython specific
prefixes such as `adafruit-micropython` to simplify the listing.
The target directory should omit any CircuitPython specific prefixes such as
`adafruit-circuitpython` to simplify the listing.

## Removing a library
Only do this if you are replacing the module with an equivalent:
Expand All @@ -42,15 +42,17 @@ Only do this if you are replacing the module with an equivalent:
git rm libraries/<target directory>

## Building the bundle
To build the bundle run `build-bundles.py` it requires Python 3.5+ and will
produce a zip file in `build`. The file structure of the zip will not be
identical to the source `libraries` directory in order to save space. Libraries
with a single source will not be placed in their own directory.

Note that `adafruit/circuitpython` is one of the submodules that is included.
It is used to build `mpy-cross` to compile the `.py` files to `.mpy`.
It is updated to the latest available tag when you run `update-submodules.sh`.

If you don't want to use the latest tagged version, make sure you checkout
an appropriate branch or tag of `circuitpython` to match the bundle version
you want to build.
To build this bundle locally you'll need to install the
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bundle --library_location libraries --library_depth 2
177 changes: 0 additions & 177 deletions build-bundles.py

This file was deleted.

1 change: 0 additions & 1 deletion circuitpython
Submodule circuitpython deleted from aca4b6