Merge pull request #3 from masenf/update-readme

Update readme

Author: masenf

.gitignore

@@ -0,0 +1,3 @@
+.pyc
+.tox
+OUTPUT

README.md

@@ -1,5 +1,8 @@
 # example-codeplug
 
+Generate DMR codeplugs from a variety of online sources using
+[dzcb](https://github.com/mycodeplug/dzcb).
+
 ## Requirements
 
 * linux or macOS (windows not yet supported)
@@ -14,23 +17,32 @@ Create / edit codeplug source files under [`/input`](/input).
 If multiple subdirectories exist under `/input`, then multiple
 codeplugs will be generated.
 
+### See [dzcb README.md](https://github.com/mycodeplug/dzcb#dzcb) for
+more information on input files and formats.
+
 ## Generating
 
 ### Github Actions
 
-If you forked this repo, first click the "Actions" tab and
-enable Github Actions for your fork.
-
-To use Repeaterbook, go to [Settings > Secrets](../../settings/secrets/actions)
-and add `REPEATERBOOK_USER` and `REPEATERBOOK_PASSWD` with your
-repeaterbook account credentials.
-
-Any changes pushed to this repository will trigger an
-automatic rebuild of all codeplugs in `input` that have
-an executable `generate.sh` file.
-
-Creating a [release](../../releases) will cause Github Actions to
-upload a `.zip` containing all of the generated codeplugs.
+* Fork this repo
+  * In the newly forked repo, click the "Actions" tab and
+    enable Github Actions for your fork.
+* Rename `input/kf7hvm` to `input/your-call`
+* customize generate.sh and other files
+  * `kf7hvm-md-uv380.json`: set your Radio ID and Radio Name
+    * Copy templates from [default-tyt-md380](https://github.com/mycodeplug/dzcb/blob/main/codeplug/default-tyt-md380) for
+      monoband variants.
+  * `order.json`: preferred zone order, zone exclusion, preferred talkgroup order
+  * `scanlists.json`: additional scanlists
+* To use Repeaterbook, go to [Settings > Secrets](../../settings/secrets/actions)
+  and set the following variables:
+  * REPEATERBOOK_USER
+  * REPEATERBOOK_PASSWD
+  * `prox.csv`: customize zones
+* Github [`codeplugs`](.github/workflows/codeplugs.yml) workflow
+  will automatically build all codeplugs in the [`input`](./input) directory.
+* When a [Release](../../releases) is published, the generated
+  codeplugs will be hosted publicly with a stable URL.
 
 ### Manual