From 3cf7e2aeda24483f0e6e91dd1d53a83b043a2329 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Sat, 12 Sep 2020 18:02:53 -0500 Subject: [PATCH] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 86dd6fd..d6a5a36 100644 --- a/README.md +++ b/README.md @@ -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: