Skip to content

Commit 41f5cc1

Browse files
authored
Merge pull request #41 from jepler/url-form-hint
Give users a hint about how a submodule URL should look
2 parents b44299b + 3cf7e2a commit 41f5cc1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ Determine the best location within `libraries` for the new library and then run:
3636
The target directory should omit any MicroPython or CircuitPython specific
3737
prefixes such as `CircuitPython_` to simplify the listing.
3838

39+
You should make sure that the git url has the format `https://github.com/{:user}/{:repo}.git`,
40+
such as `https://github.com/tannewt/CircuitPython_Example.git`. Other forms may interfere with
41+
adabot scripts (see https://github.com/adafruit/adabot/issues/145 for details).
42+
3943
## Removing a library
4044
Only do this if you are replacing the module with an equivalent:
4145

0 commit comments

Comments
 (0)