From 80000fc979a385e510bee49f9534c9e0dfb78014 Mon Sep 17 00:00:00 2001 From: Masen Furer Date: Sun, 24 Jan 2021 16:45:16 -0800 Subject: [PATCH 1/2] README.md: copy customize instructions from dzcb Prominently link to dzcb README which has more information. --- README.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4abdb6a..bc64c93 100644 --- a/README.md +++ b/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 From 7d0ae3605584f99b506461e60d84f43b080f75d1 Mon Sep 17 00:00:00 2001 From: Masen Furer Date: Sun, 24 Jan 2021 16:45:59 -0800 Subject: [PATCH 2/2] .gitignore: ignore .tox OUTPUT and .pyc --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e78a192 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.pyc +.tox +OUTPUT