Skip to content

Commit

Permalink
Merge pull request #41 from jepler/url-form-hint
Browse files Browse the repository at this point in the history
Give users a hint about how a submodule URL should look
  • Loading branch information
jepler authored Sep 13, 2020
2 parents b44299b + 3cf7e2a commit 41f5cc1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ Determine the best location within `libraries` for the new library and then run:
The target directory should omit any MicroPython or CircuitPython specific
prefixes such as `CircuitPython_` to simplify the listing.

You should make sure that the git url has the format `https://github.com/{:user}/{:repo}.git`,
such as `https://github.com/tannewt/CircuitPython_Example.git`. Other forms may interfere with
adabot scripts (see https://github.com/adafruit/adabot/issues/145 for details).

## Removing a library
Only do this if you are replacing the module with an equivalent:

Expand Down

0 comments on commit 41f5cc1

Please sign in to comment.