From 0300be1c4b81559f23957d7bbd441a7bcf0ee587 Mon Sep 17 00:00:00 2001 From: Ryzerth Date: Mon, 26 Apr 2021 19:59:41 +0200 Subject: [PATCH] Fixed contributing.md --- .github/workflows/build_all.yml | 14 +++++++------- contributing.md | 16 +++++++++------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/.github/workflows/build_all.yml b/.github/workflows/build_all.yml index 0aec24ca..90e29d18 100644 --- a/.github/workflows/build_all.yml +++ b/.github/workflows/build_all.yml @@ -196,13 +196,13 @@ jobs: working-directory: ${{runner.workspace}} run: > mkdir sdrpp_all && - mv build_windows/sdrpp_windows_x64.zip sdrpp_all/ && - mv build_debian_buster/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_debian_buster_amd64.deb && - mv build_debian_bullseye/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_debian_bullseye_amd64.deb && - mv build_debian_sid/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_debian_sid_amd64.deb && - mv build_ubuntu_focal/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_ubuntu_focal_amd64.deb && - mv build_ubuntu_groovy/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_ubuntu_groovy_amd64.deb && - mv build_ubuntu_hirsute/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_ubuntu_hirsute_amd64.deb + mv sdrpp_windows_x64/sdrpp_windows_x64.zip sdrpp_all/ && + mv sdrpp_debian_buster_amd64/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_debian_buster_amd64.deb && + mv sdrpp_debian_bullseye_amd64/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_debian_bullseye_amd64.deb && + mv sdrpp_debian_sid_amd64/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_debian_sid_amd64.deb && + mv sdrpp_ubuntu_focal_amd64/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_ubuntu_focal_amd64.deb && + mv sdrpp_ubuntu_groovy_amd64/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_ubuntu_groovy_amd64.deb && + mv sdrpp_ubuntu_hirsute_amd64/sdrpp_debian_amd64.deb sdrpp_all/sdrpp_ubuntu_hirsute_amd64.deb - uses: actions/upload-artifact@v2 with: diff --git a/contributing.md b/contributing.md index a45bfda0..27c1f078 100644 --- a/contributing.md +++ b/contributing.md @@ -53,28 +53,30 @@ If the module meets the code quality requirements, it may be added to the offici The ability to add new radio band allocation identifiers and color maps relies on JSON files. Proper formatting of these JSOn files is important for reference and readability. The folowing guides will show you how to properly format the JSON files for their respective uses. +**IMPORTANT: JSON File cannot contain comments, there are only in this example for clarity** + ## Band Frequency Allocation Please follow this guide to properly format the JSON files for custom radio band allocation identifiers. ```json { - "name": "Single Word: Name of the band plan ", - "country_name": "Name of country, if applicable (Use 'Worldwide' otherwise)", - "country_code": "Two letter country code, if applicable (Use '--' otherwise", + "name": "Short name (has to fit in the menu)", + "country_name": "Name of country or area, if applicable (Use '--' otherwise)", + "country_code": "Two letter country code, if applicable (Use '--' otherwise)", "author_name": "Name of the original/main creator of the JSON file", "author_url": "URL the author wishes to be associated with the file (personal website, GitHub, Twitter, etc)", "bands": [ // Bands in this array must be sorted by their starting frequency { "name": "Name of the band", - "type": "Type of band (Amatuer, Broadcast, Marine, Military, or Satellite)", + "type": "Type name ('amateur', 'broadcast', 'marine', 'military', or any type decalre in config.json)", "start": 148500, //In Hz, must be an integer "end": 283500 //In Hz, must be an integer }, { "name": "Name of the band", - "type": "Type of band (Amatuer, Broadcast, Marine, Military, or Satellite)", + "type": "Type name ('amateur', 'broadcast', 'marine', 'military', or any type decalre in config.json)", "start": 526500, //In Hz, must be an integer "end": 1606500 //In Hz, must be an integer } @@ -88,10 +90,10 @@ Please follow this guide to properly format the JSON files for custom color maps ```json { - "name": "Name of the color map in a single word", + "name": "Short name (has to fit in the menu)", "author": "Name of the original/main creator of the color map", "map": [ - // These are the color codes, in hexidecimal format, for the custom color scales for the waterfall. They must be entered as strings, not integers, with the hastag/pound-symbol proceeding the 6 digit number. + // These are the color codes, in hexidecimal (#RRGGBB) format, for the custom color scales for the waterfall. They must be entered as strings, not integers, with the hastag/pound-symbol proceeding the 6 digit number. "#000020", "#000030", "#000050",