File tree Expand file tree Collapse file tree 2 files changed +23
-0
lines changed Expand file tree Collapse file tree 2 files changed +23
-0
lines changed Original file line number Diff line number Diff line change
1
+ Developing Libraries in the Bundle
2
+ ==================================
3
+
4
+ Adafruit CircuitPython libraries are generally installable on a CPython interpreter with `pip ` (or other package
5
+ managers). The "Blinka" libraries are compatibility layers to fill in missing pieces that are expected from
6
+ CircuitPython. Unfortunately, some of these compatibility layers may not work in all environments.
7
+
8
+ Unless you are working with all of the libaries at the same time, the easiest workflow for development is to fork an
9
+ individual library and make your changes there before submitting a PR back to the adafruit repository. If, however, you
10
+ want to programmatically modify all libraries in this bundle, it may be more efficient to do development within this
11
+ repository.
12
+
13
+ Code Hygiene
14
+ ------------
15
+
16
+ Adafruit libraries are not currently fully typed. If you would like to improve the typing coverage, we suggest
17
+ `installing mypy `_. You can then run mypy from the command line or from within your editor / IDE.
18
+
19
+ .. _installing mypy : https://mypy.readthedocs.io/en/stable/getting_started.html#installing-and-running-mypy
20
+
21
+
Original file line number Diff line number Diff line change @@ -41,6 +41,8 @@ Development
41
41
After you clone this repository you must run ``git submodule init ``
42
42
and then ``git submodule update ``.
43
43
44
+ For developing individual libraries, please see LIBRARY_DEVELOPMENT.rst.
45
+
44
46
Updating libraries
45
47
-------------------
46
48
To update the libraries run ``update-submodules.sh ``. The script will fetch the
You can’t perform that action at this time.
0 commit comments