@@ -33,6 +33,18 @@ Create / edit codeplug source files under [`/input`](/input).
3333If multiple subdirectories exist under ` /input ` , then multiple
3434codeplugs will be generated.
3535
36+ The [ ` default ` ] ( ./input/default ) directory contains the example codeplug
37+ input files along with 2 scripts:
38+
39+ * [ ` generate.sh ` ] ( ./input/default/generate.sh ) builds the codeplug with a
40+ standard bash shell command.
41+ * [ ` generate.py ` ] ( ./input/default/generate.py ) builds the same codeplug
42+ using python code.
43+
44+ Derivative codeplugs don't need to include both scripts. Use the format
45+ that is most familiar. While the sample scripts show identical functionality,
46+ the python code could be extended to hack at the generation process itself.
47+
3648### See [ dzcb README.md] ( https://github.com/mycodeplug/dzcb#dzcb ) for more information on input files and formats.
3749
3850## Generating
@@ -51,6 +63,11 @@ for step-by-step instructions.
5163 * Copy templates from
5264 [ default-tyt-md380] ( https://github.com/mycodeplug/dzcb/blob/main/codeplug/default-tyt-md380 )
5365 for monoband variants.
66+ * [ ` example-d878uv.conf ` ] ( ./input/default/example-d878uv.conf ) :
67+ set your Radio ID and Radio Name
68+ * See README and templates in
69+ [ dmrconfig] ( https://github.com/mycodeplug/dzcb/blob/main/src/dzcb/data/dmrconfig )
70+ for more information and other radio types.
5471 * [ ` k7abd ` ] ( ./input/default/k7abd ) : manually defined zones in
5572 K7ABD anytone-config-builder format. See N7EKB's
5673 [ ` cps-import-builder ` reference data files] ( https://github.com/n7ekb/cps-import-builder/tree/main/reference_data_files/N7EKB_shared_files )
@@ -59,7 +76,7 @@ for step-by-step instructions.
5976 * [ ` exclude.csv ` ] ( ./input/default/exclude.csv ) : zone, contact, channel exclude
6077 * [ ` replacements.csv ` ] ( ./input/default/replacements.csv ) : object name replacements (regex)
6178 * [ ` scanlists.json ` ] ( ./input/default/scanlists.json ) : additional scanlists
62- * [ ` generate.sh ` ] ( ./input/default/generate.sh ) : options passed to ` dzcb ` (whether
79+ * [ ` generate.py ` ] ( ./input/default/generate.py ) : options passed to ` dzcb ` (whether
6380 to include PNWDigital, SeattleDMR, default files, etc)
6481* [ ` prox.csv ` ] ( ./input/default/prox.csv ) : customize points of
6582 interest, distances, and desired bands
@@ -76,7 +93,17 @@ for step-by-step instructions.
7693* python 3.6+ (python 3.8 recommended)
7794* [ tox] ( https://tox.readthedocs.io/en/latest/ )
7895
96+ #### Build
97+
98+ To output to a specific directory, set the ` OUTPUT ` environment variable.
99+
79100```
80101pip install tox
81102tox
82103```
104+
105+ To run the ` generate.sh ` shell scripts
106+
107+ ```
108+ tox -e shell
109+ ```
0 commit comments