Merge pull request #41 from jepler/url-form-hint

Give users a hint about how a submodule URL should look
This commit is contained in:
Jeff Epler 2020-09-13 07:46:31 -05:00 committed by GitHub
commit 41f5cc13b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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: