From c0999a64cd74015324b225abf8c8e31a9313b6d9 Mon Sep 17 00:00:00 2001 From: Igor Date: Wed, 6 Dec 2023 21:54:38 +0100 Subject: [PATCH 01/10] Update Quick start After verifying if we put it into wanted folders and if it works, automation builds upon changes. --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 69fb59e5..ebc0dfa2 100755 --- a/README.md +++ b/README.md @@ -11,11 +11,8 @@ ## Quick start Run the following commands: - sudo apt install git - cd ~/ - git clone https://github.com/armbian/configng.git - cd configng - ./bin/armbian-configng --dev + echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null + armbian-configng --dev If all goes well you should see the Text-Based User Inerface (TUI) From b4034d75911245aad298f0210d87ef1e854c317f Mon Sep 17 00:00:00 2001 From: Igor Date: Wed, 6 Dec 2023 21:54:57 +0100 Subject: [PATCH 02/10] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ebc0dfa2..d3c51200 100755 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ ## Quick start Run the following commands: - echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null + echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" \ + | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null + armbian-configng --dev If all goes well you should see the Text-Based User Inerface (TUI) From 9f6804948ee799e596fa6230a12138db05aafbd8 Mon Sep 17 00:00:00 2001 From: Igor Date: Wed, 6 Dec 2023 21:55:11 +0100 Subject: [PATCH 03/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d3c51200..e771a0d6 100755 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ If all goes well you should see the Text-Based User Inerface (TUI) ### To see a list of all functions and their descriptions, run the following command: ~~~ -bash ~/configng/bin/armbian-configng -h +armbian-configng -h ~~~ ## Coding Style follow the following coding style: From db6f4f4034cf2d00361fe0ccdbe4c943b2e3e07d Mon Sep 17 00:00:00 2001 From: Joey Turner Date: Fri, 8 Dec 2023 19:28:16 +0000 Subject: [PATCH 04/10] Updated readme.md function to redirect to /share/doc/README.md --- lib/armbian-configng/documents.sh | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/lib/armbian-configng/documents.sh b/lib/armbian-configng/documents.sh index 8a319822..00b71fa5 100644 --- a/lib/armbian-configng/documents.sh +++ b/lib/armbian-configng/documents.sh @@ -218,11 +218,15 @@ cat << EOF ## Quick start Run the following commands: - sudo apt install git - cd ~/ - git clone https://github.com/armbian/configng.git - cd configng - ./bin/${file_name%.*} --dev + echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" \ + | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null + + + sudo armbian-configng + +or + + armbian-configng --dev If all goes well you should see the Text-Based User Inerface (TUI) @@ -368,17 +372,18 @@ generate_and_print() { } generate_doc() { - dir="$(dirname "$(dirname "$(realpath "$0")")")/share/${filename%-dev}" + dir="$(dirname "$(dirname "$(realpath "$0")")")/share/doc/$filename" if [[ ! -d "$dir" ]]; then - mkdir -p "$dir/data/" + mkdir -p "$dir" fi cd "$dir" || exit - generate_svg > "$filename.svg" - generate_and_print generate_markdown "../../readme" md "readme.md" - generate_and_print generate_html "../../index" html "index.html" - generate_and_print generate_html5 "index" html "HTML5" - generate_and_print generate_json "data/$filename" json "JSON" - generate_and_print generate_csv "data/${filename%-dev}" csv "CSV" + generate_and_print generate_svg "armbianCPU" "svg" "armbianCPU.svg" + generate_and_print generate_markdown "README" md "README.md" + generate_and_print generate_html "index" html "index.html" + generate_and_print generate_html5 "$filename" html "HTML5" + generate_and_print generate_json "$filename" json "JSON" + generate_and_print generate_csv "$filename" csv "CSV" + # May not longer be needed if [[ "$EUID" -eq 0 ]]; then chown -R "$SUDO_USER":"$SUDO_USER" "$(dirname "$dir")" cd ../../ From b261fa47eb6af19335f1832f1ddaf60a04d573a2 Mon Sep 17 00:00:00 2001 From: Joey Turner Date: Fri, 8 Dec 2023 20:57:16 +0000 Subject: [PATCH 05/10] Run doc gen --- share/doc/armbian-configng/README.md | 87 ++++++++++++++++ .../doc/armbian-configng/armbian-configng.csv | 5 + .../armbian-configng/armbian-configng.html | 98 +++++++++++++++++++ .../armbian-configng/armbian-configng.json | 34 +++++++ share/doc/armbian-configng/armbianCPU.svg | 5 + share/doc/armbian-configng/index.html | 42 ++++++++ 6 files changed, 271 insertions(+) create mode 100755 share/doc/armbian-configng/README.md create mode 100755 share/doc/armbian-configng/armbian-configng.csv create mode 100755 share/doc/armbian-configng/armbian-configng.html create mode 100755 share/doc/armbian-configng/armbian-configng.json create mode 100755 share/doc/armbian-configng/armbianCPU.svg create mode 100755 share/doc/armbian-configng/index.html diff --git a/share/doc/armbian-configng/README.md b/share/doc/armbian-configng/README.md new file mode 100755 index 00000000..b4fb82ff --- /dev/null +++ b/share/doc/armbian-configng/README.md @@ -0,0 +1,87 @@ + +

+ Armbian logo +
+ Armbian ConfigNG +
+ CodeFactor +

+ +# User guide +## Quick start +Run the following commands: + + echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null + + + sudo armbian-configng + +or + + armbian-configng --dev + +If all goes well you should see the Text-Based User Inerface (TUI) + +### To see a list of all functions and their descriptions, run the following command: +~~~ +bash ~/configng/bin/armbian-configng -h +~~~ +## Coding Style +follow the following coding style: +~~~ +# @description A short description of the function. +# +# @exitcode 0 If successful. +# +# @options A description if there are options. +function group::string() {s + echo "hello world" + return 0 +} +~~~ +## Codestyle can be used to auto generate + - [Markdown](share/armbian-configng/readme.md) + - [JSON](share/armbian-configng/data/armbian-configng.json) + - [CSV](share/armbian-configng/data/armbian-configng.csv) + - [HTML](share/armbian-configng/armbian-configng-table.html) + - [github.io](//tearran/github.io/armbian-configng/index.html) +## Functions list as of 2023-12-08 +## network +System and Security + +### set_wifi.sh + + - **Group Name:** network + - **Action Name:** NMTUI + - **Options:** none. + - **Description:** Network Manager. + +## system +Network Wired wireless Bluetooth access point + +### armbian_install.sh + + - **Group Name:** system + - **Action Name:** Install + - **Options:** none. + - **Description:** Armbian installer + +### hello_world.sh + + - **Group Name:** system + - **Action Name:** Hello + - **Options:** none + - **Description:** Hello System. + +### see_monitor.sh + + - **Group Name:** monitor + - **Action Name:** Bencharking + - **Options:** + - **Description:** Armbian Monitor and Bencharking. + + +# Inclueded projects +- [Bash Utility](https://labbots.github.io/bash-utility) +- [Armbian config](https://github.com/armbian/config.git) + diff --git a/share/doc/armbian-configng/armbian-configng.csv b/share/doc/armbian-configng/armbian-configng.csv new file mode 100755 index 00000000..717776e7 --- /dev/null +++ b/share/doc/armbian-configng/armbian-configng.csv @@ -0,0 +1,5 @@ +Function Name,Group Name,Description,Options,Category,Category Description +NMTUI,network,Network Manager.,none.,network,Network Wired wireless Bluetooth access point +Hello,system,Hello System.,none,system,System and Security +Bencharking,monitor,Armbian Monitor and Bencharking.,,system,System and Security +Install,system,Armbian installer,none.,system,System and Security diff --git a/share/doc/armbian-configng/armbian-configng.html b/share/doc/armbian-configng/armbian-configng.html new file mode 100755 index 00000000..b80abc8d --- /dev/null +++ b/share/doc/armbian-configng/armbian-configng.html @@ -0,0 +1,98 @@ + + + + + + Armbian armbian-configng + + + +
+

armbian-configng

+
+ +
+
+ +
+
+ + + + + + diff --git a/share/doc/armbian-configng/armbian-configng.json b/share/doc/armbian-configng/armbian-configng.json new file mode 100755 index 00000000..eb936b4b --- /dev/null +++ b/share/doc/armbian-configng/armbian-configng.json @@ -0,0 +1,34 @@ +[ + { + "Function Name": "NMTUI", + "Group Name": "network", + "Description": "Network Manager.", + "Options": "none.", + "Category": "network", + "Category Description": "Network Wired wireless Bluetooth access point" + }, + { + "Function Name": "Hello", + "Group Name": "system", + "Description": "Hello System.", + "Options": "none", + "Category": "system", + "Category Description": "System and Security" + }, + { + "Function Name": "Bencharking", + "Group Name": "monitor", + "Description": "Armbian Monitor and Bencharking.", + "Options": "", + "Category": "system", + "Category Description": "System and Security" + }, + { + "Function Name": "Install", + "Group Name": "system", + "Description": "Armbian installer", + "Options": "none.", + "Category": "system", + "Category Description": "System and Security" + } +] diff --git a/share/doc/armbian-configng/armbianCPU.svg b/share/doc/armbian-configng/armbianCPU.svg new file mode 100755 index 00000000..4d19784d --- /dev/null +++ b/share/doc/armbian-configng/armbianCPU.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/share/doc/armbian-configng/index.html b/share/doc/armbian-configng/index.html new file mode 100755 index 00000000..0f3d2f12 --- /dev/null +++ b/share/doc/armbian-configng/index.html @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + +
Function NameGroup NameDescriptionOptionsCategoryCategory Description
NMTUInetworkNetwork Manager.none.networkNetwork Wired wireless Bluetooth access point
HellosystemHello System.nonesystemSystem and Security
BencharkingmonitorArmbian Monitor and Bencharking.systemSystem and Security
InstallsystemArmbian installernone.systemSystem and Security
+ + + From 9f63d9eee17608890b104a6c614db99a8b5eece4 Mon Sep 17 00:00:00 2001 From: Joey Turner Date: Fri, 8 Dec 2023 21:21:10 +0000 Subject: [PATCH 06/10] RM genterated documents folder --- share/armbian-configng/armbian-configng.svg | 5 - .../data/armbian-configng.csv | 4 - .../data/armbian-configng.json | 26 ----- share/armbian-configng/index.html | 90 ----------------- share/doc/armbian-configng/README.md | 87 ---------------- .../doc/armbian-configng/armbian-configng.csv | 5 - .../armbian-configng/armbian-configng.html | 98 ------------------- .../armbian-configng/armbian-configng.json | 34 ------- share/doc/armbian-configng/armbianCPU.svg | 5 - share/doc/armbian-configng/index.html | 42 -------- 10 files changed, 396 deletions(-) delete mode 100644 share/armbian-configng/armbian-configng.svg delete mode 100755 share/armbian-configng/data/armbian-configng.csv delete mode 100755 share/armbian-configng/data/armbian-configng.json delete mode 100755 share/armbian-configng/index.html delete mode 100755 share/doc/armbian-configng/README.md delete mode 100755 share/doc/armbian-configng/armbian-configng.csv delete mode 100755 share/doc/armbian-configng/armbian-configng.html delete mode 100755 share/doc/armbian-configng/armbian-configng.json delete mode 100755 share/doc/armbian-configng/armbianCPU.svg delete mode 100755 share/doc/armbian-configng/index.html diff --git a/share/armbian-configng/armbian-configng.svg b/share/armbian-configng/armbian-configng.svg deleted file mode 100644 index 4d19784d..00000000 --- a/share/armbian-configng/armbian-configng.svg +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/share/armbian-configng/data/armbian-configng.csv b/share/armbian-configng/data/armbian-configng.csv deleted file mode 100755 index ee79cbe1..00000000 --- a/share/armbian-configng/data/armbian-configng.csv +++ /dev/null @@ -1,4 +0,0 @@ -Function Name,Group Name,Description,Options,Category,Category Description -NMTUI,network,Network Manager.,none.,network,Network Wired wireless Bluetooth access point -Hello,system,Hello System.,none,system,System and Security -Bencharking,monitor,Armbian Monitor and Bencharking.,,system,System and Security diff --git a/share/armbian-configng/data/armbian-configng.json b/share/armbian-configng/data/armbian-configng.json deleted file mode 100755 index e3a2fea3..00000000 --- a/share/armbian-configng/data/armbian-configng.json +++ /dev/null @@ -1,26 +0,0 @@ -[ - { - "Function Name": "NMTUI", - "Group Name": "network", - "Description": "Network Manager.", - "Options": "none.", - "Category": "network", - "Category Description": "Network Wired wireless Bluetooth access point" - }, - { - "Function Name": "Hello", - "Group Name": "system", - "Description": "Hello System.", - "Options": "none", - "Category": "system", - "Category Description": "System and Security" - }, - { - "Function Name": "Bencharking", - "Group Name": "monitor", - "Description": "Armbian Monitor and Bencharking.", - "Options": "", - "Category": "system", - "Category Description": "System and Security" - } -] diff --git a/share/armbian-configng/index.html b/share/armbian-configng/index.html deleted file mode 100755 index d5e3ccce..00000000 --- a/share/armbian-configng/index.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Armbian index - - - -
-

index

-
- -
-
- -
-
- - - - - - diff --git a/share/doc/armbian-configng/README.md b/share/doc/armbian-configng/README.md deleted file mode 100755 index b4fb82ff..00000000 --- a/share/doc/armbian-configng/README.md +++ /dev/null @@ -1,87 +0,0 @@ - -

- Armbian logo -
- Armbian ConfigNG -
- CodeFactor -

- -# User guide -## Quick start -Run the following commands: - - echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null - - - sudo armbian-configng - -or - - armbian-configng --dev - -If all goes well you should see the Text-Based User Inerface (TUI) - -### To see a list of all functions and their descriptions, run the following command: -~~~ -bash ~/configng/bin/armbian-configng -h -~~~ -## Coding Style -follow the following coding style: -~~~ -# @description A short description of the function. -# -# @exitcode 0 If successful. -# -# @options A description if there are options. -function group::string() {s - echo "hello world" - return 0 -} -~~~ -## Codestyle can be used to auto generate - - [Markdown](share/armbian-configng/readme.md) - - [JSON](share/armbian-configng/data/armbian-configng.json) - - [CSV](share/armbian-configng/data/armbian-configng.csv) - - [HTML](share/armbian-configng/armbian-configng-table.html) - - [github.io](//tearran/github.io/armbian-configng/index.html) -## Functions list as of 2023-12-08 -## network -System and Security - -### set_wifi.sh - - - **Group Name:** network - - **Action Name:** NMTUI - - **Options:** none. - - **Description:** Network Manager. - -## system -Network Wired wireless Bluetooth access point - -### armbian_install.sh - - - **Group Name:** system - - **Action Name:** Install - - **Options:** none. - - **Description:** Armbian installer - -### hello_world.sh - - - **Group Name:** system - - **Action Name:** Hello - - **Options:** none - - **Description:** Hello System. - -### see_monitor.sh - - - **Group Name:** monitor - - **Action Name:** Bencharking - - **Options:** - - **Description:** Armbian Monitor and Bencharking. - - -# Inclueded projects -- [Bash Utility](https://labbots.github.io/bash-utility) -- [Armbian config](https://github.com/armbian/config.git) - diff --git a/share/doc/armbian-configng/armbian-configng.csv b/share/doc/armbian-configng/armbian-configng.csv deleted file mode 100755 index 717776e7..00000000 --- a/share/doc/armbian-configng/armbian-configng.csv +++ /dev/null @@ -1,5 +0,0 @@ -Function Name,Group Name,Description,Options,Category,Category Description -NMTUI,network,Network Manager.,none.,network,Network Wired wireless Bluetooth access point -Hello,system,Hello System.,none,system,System and Security -Bencharking,monitor,Armbian Monitor and Bencharking.,,system,System and Security -Install,system,Armbian installer,none.,system,System and Security diff --git a/share/doc/armbian-configng/armbian-configng.html b/share/doc/armbian-configng/armbian-configng.html deleted file mode 100755 index b80abc8d..00000000 --- a/share/doc/armbian-configng/armbian-configng.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Armbian armbian-configng - - - -
-

armbian-configng

-
- -
-
- -
-
- - - - - - diff --git a/share/doc/armbian-configng/armbian-configng.json b/share/doc/armbian-configng/armbian-configng.json deleted file mode 100755 index eb936b4b..00000000 --- a/share/doc/armbian-configng/armbian-configng.json +++ /dev/null @@ -1,34 +0,0 @@ -[ - { - "Function Name": "NMTUI", - "Group Name": "network", - "Description": "Network Manager.", - "Options": "none.", - "Category": "network", - "Category Description": "Network Wired wireless Bluetooth access point" - }, - { - "Function Name": "Hello", - "Group Name": "system", - "Description": "Hello System.", - "Options": "none", - "Category": "system", - "Category Description": "System and Security" - }, - { - "Function Name": "Bencharking", - "Group Name": "monitor", - "Description": "Armbian Monitor and Bencharking.", - "Options": "", - "Category": "system", - "Category Description": "System and Security" - }, - { - "Function Name": "Install", - "Group Name": "system", - "Description": "Armbian installer", - "Options": "none.", - "Category": "system", - "Category Description": "System and Security" - } -] diff --git a/share/doc/armbian-configng/armbianCPU.svg b/share/doc/armbian-configng/armbianCPU.svg deleted file mode 100755 index 4d19784d..00000000 --- a/share/doc/armbian-configng/armbianCPU.svg +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/share/doc/armbian-configng/index.html b/share/doc/armbian-configng/index.html deleted file mode 100755 index 0f3d2f12..00000000 --- a/share/doc/armbian-configng/index.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - - - - - - - - - - - -
Function NameGroup NameDescriptionOptionsCategoryCategory Description
NMTUInetworkNetwork Manager.none.networkNetwork Wired wireless Bluetooth access point
HellosystemHello System.nonesystemSystem and Security
BencharkingmonitorArmbian Monitor and Bencharking.systemSystem and Security
InstallsystemArmbian installernone.systemSystem and Security
- - - From f85612ef4fccb4da5f3c908a2283f0ddda4efd1f Mon Sep 17 00:00:00 2001 From: Joey Turner Date: Fri, 8 Dec 2023 21:22:26 +0000 Subject: [PATCH 07/10] bin/armbian-configng --dev --doc codespace --- share/doc/armbian-configng/README.md | 87 ++++++++++++++++ .../doc/armbian-configng/armbian-configng.csv | 5 + .../armbian-configng/armbian-configng.html | 98 +++++++++++++++++++ .../armbian-configng/armbian-configng.json | 34 +++++++ share/doc/armbian-configng/armbianCPU.svg | 5 + share/doc/armbian-configng/index.html | 42 ++++++++ 6 files changed, 271 insertions(+) create mode 100755 share/doc/armbian-configng/README.md create mode 100755 share/doc/armbian-configng/armbian-configng.csv create mode 100755 share/doc/armbian-configng/armbian-configng.html create mode 100755 share/doc/armbian-configng/armbian-configng.json create mode 100755 share/doc/armbian-configng/armbianCPU.svg create mode 100755 share/doc/armbian-configng/index.html diff --git a/share/doc/armbian-configng/README.md b/share/doc/armbian-configng/README.md new file mode 100755 index 00000000..b4fb82ff --- /dev/null +++ b/share/doc/armbian-configng/README.md @@ -0,0 +1,87 @@ + +

+ Armbian logo +
+ Armbian ConfigNG +
+ CodeFactor +

+ +# User guide +## Quick start +Run the following commands: + + echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null + + + sudo armbian-configng + +or + + armbian-configng --dev + +If all goes well you should see the Text-Based User Inerface (TUI) + +### To see a list of all functions and their descriptions, run the following command: +~~~ +bash ~/configng/bin/armbian-configng -h +~~~ +## Coding Style +follow the following coding style: +~~~ +# @description A short description of the function. +# +# @exitcode 0 If successful. +# +# @options A description if there are options. +function group::string() {s + echo "hello world" + return 0 +} +~~~ +## Codestyle can be used to auto generate + - [Markdown](share/armbian-configng/readme.md) + - [JSON](share/armbian-configng/data/armbian-configng.json) + - [CSV](share/armbian-configng/data/armbian-configng.csv) + - [HTML](share/armbian-configng/armbian-configng-table.html) + - [github.io](//tearran/github.io/armbian-configng/index.html) +## Functions list as of 2023-12-08 +## network +System and Security + +### set_wifi.sh + + - **Group Name:** network + - **Action Name:** NMTUI + - **Options:** none. + - **Description:** Network Manager. + +## system +Network Wired wireless Bluetooth access point + +### armbian_install.sh + + - **Group Name:** system + - **Action Name:** Install + - **Options:** none. + - **Description:** Armbian installer + +### hello_world.sh + + - **Group Name:** system + - **Action Name:** Hello + - **Options:** none + - **Description:** Hello System. + +### see_monitor.sh + + - **Group Name:** monitor + - **Action Name:** Bencharking + - **Options:** + - **Description:** Armbian Monitor and Bencharking. + + +# Inclueded projects +- [Bash Utility](https://labbots.github.io/bash-utility) +- [Armbian config](https://github.com/armbian/config.git) + diff --git a/share/doc/armbian-configng/armbian-configng.csv b/share/doc/armbian-configng/armbian-configng.csv new file mode 100755 index 00000000..717776e7 --- /dev/null +++ b/share/doc/armbian-configng/armbian-configng.csv @@ -0,0 +1,5 @@ +Function Name,Group Name,Description,Options,Category,Category Description +NMTUI,network,Network Manager.,none.,network,Network Wired wireless Bluetooth access point +Hello,system,Hello System.,none,system,System and Security +Bencharking,monitor,Armbian Monitor and Bencharking.,,system,System and Security +Install,system,Armbian installer,none.,system,System and Security diff --git a/share/doc/armbian-configng/armbian-configng.html b/share/doc/armbian-configng/armbian-configng.html new file mode 100755 index 00000000..b80abc8d --- /dev/null +++ b/share/doc/armbian-configng/armbian-configng.html @@ -0,0 +1,98 @@ + + + + + + Armbian armbian-configng + + + +
+

armbian-configng

+
+ +
+
+ +
+
+ + + + + + diff --git a/share/doc/armbian-configng/armbian-configng.json b/share/doc/armbian-configng/armbian-configng.json new file mode 100755 index 00000000..eb936b4b --- /dev/null +++ b/share/doc/armbian-configng/armbian-configng.json @@ -0,0 +1,34 @@ +[ + { + "Function Name": "NMTUI", + "Group Name": "network", + "Description": "Network Manager.", + "Options": "none.", + "Category": "network", + "Category Description": "Network Wired wireless Bluetooth access point" + }, + { + "Function Name": "Hello", + "Group Name": "system", + "Description": "Hello System.", + "Options": "none", + "Category": "system", + "Category Description": "System and Security" + }, + { + "Function Name": "Bencharking", + "Group Name": "monitor", + "Description": "Armbian Monitor and Bencharking.", + "Options": "", + "Category": "system", + "Category Description": "System and Security" + }, + { + "Function Name": "Install", + "Group Name": "system", + "Description": "Armbian installer", + "Options": "none.", + "Category": "system", + "Category Description": "System and Security" + } +] diff --git a/share/doc/armbian-configng/armbianCPU.svg b/share/doc/armbian-configng/armbianCPU.svg new file mode 100755 index 00000000..4d19784d --- /dev/null +++ b/share/doc/armbian-configng/armbianCPU.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/share/doc/armbian-configng/index.html b/share/doc/armbian-configng/index.html new file mode 100755 index 00000000..0f3d2f12 --- /dev/null +++ b/share/doc/armbian-configng/index.html @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + +
Function NameGroup NameDescriptionOptionsCategoryCategory Description
NMTUInetworkNetwork Manager.none.networkNetwork Wired wireless Bluetooth access point
HellosystemHello System.nonesystemSystem and Security
BencharkingmonitorArmbian Monitor and Bencharking.systemSystem and Security
InstallsystemArmbian installernone.systemSystem and Security
+ + + From 235e8c9cde49d56a9f814d06a077ab04b4eab486 Mon Sep 17 00:00:00 2001 From: Joey Turner Date: Fri, 8 Dec 2023 21:46:40 +0000 Subject: [PATCH 08/10] deleted: share/doc/armbian-configng/README.md --- share/doc/armbian-configng/README.md | 87 ---------------------------- 1 file changed, 87 deletions(-) delete mode 100755 share/doc/armbian-configng/README.md diff --git a/share/doc/armbian-configng/README.md b/share/doc/armbian-configng/README.md deleted file mode 100755 index b4fb82ff..00000000 --- a/share/doc/armbian-configng/README.md +++ /dev/null @@ -1,87 +0,0 @@ - -

- Armbian logo -
- Armbian ConfigNG -
- CodeFactor -

- -# User guide -## Quick start -Run the following commands: - - echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null - - - sudo armbian-configng - -or - - armbian-configng --dev - -If all goes well you should see the Text-Based User Inerface (TUI) - -### To see a list of all functions and their descriptions, run the following command: -~~~ -bash ~/configng/bin/armbian-configng -h -~~~ -## Coding Style -follow the following coding style: -~~~ -# @description A short description of the function. -# -# @exitcode 0 If successful. -# -# @options A description if there are options. -function group::string() {s - echo "hello world" - return 0 -} -~~~ -## Codestyle can be used to auto generate - - [Markdown](share/armbian-configng/readme.md) - - [JSON](share/armbian-configng/data/armbian-configng.json) - - [CSV](share/armbian-configng/data/armbian-configng.csv) - - [HTML](share/armbian-configng/armbian-configng-table.html) - - [github.io](//tearran/github.io/armbian-configng/index.html) -## Functions list as of 2023-12-08 -## network -System and Security - -### set_wifi.sh - - - **Group Name:** network - - **Action Name:** NMTUI - - **Options:** none. - - **Description:** Network Manager. - -## system -Network Wired wireless Bluetooth access point - -### armbian_install.sh - - - **Group Name:** system - - **Action Name:** Install - - **Options:** none. - - **Description:** Armbian installer - -### hello_world.sh - - - **Group Name:** system - - **Action Name:** Hello - - **Options:** none - - **Description:** Hello System. - -### see_monitor.sh - - - **Group Name:** monitor - - **Action Name:** Bencharking - - **Options:** - - **Description:** Armbian Monitor and Bencharking. - - -# Inclueded projects -- [Bash Utility](https://labbots.github.io/bash-utility) -- [Armbian config](https://github.com/armbian/config.git) - From a189d4559bdf023df22aa48e6036cd42b26b4975 Mon Sep 17 00:00:00 2001 From: Joey Turner Date: Sat, 9 Dec 2023 05:19:01 +0000 Subject: [PATCH 09/10] Revert "Updated readme.md function to redirect to /share/doc/README.md" This reverts commit db6f4f4034cf2d00361fe0ccdbe4c943b2e3e07d. --- lib/armbian-configng/documents.sh | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/lib/armbian-configng/documents.sh b/lib/armbian-configng/documents.sh index 00b71fa5..8a319822 100644 --- a/lib/armbian-configng/documents.sh +++ b/lib/armbian-configng/documents.sh @@ -218,15 +218,11 @@ cat << EOF ## Quick start Run the following commands: - echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" \ - | sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null - - - sudo armbian-configng - -or - - armbian-configng --dev + sudo apt install git + cd ~/ + git clone https://github.com/armbian/configng.git + cd configng + ./bin/${file_name%.*} --dev If all goes well you should see the Text-Based User Inerface (TUI) @@ -372,18 +368,17 @@ generate_and_print() { } generate_doc() { - dir="$(dirname "$(dirname "$(realpath "$0")")")/share/doc/$filename" + dir="$(dirname "$(dirname "$(realpath "$0")")")/share/${filename%-dev}" if [[ ! -d "$dir" ]]; then - mkdir -p "$dir" + mkdir -p "$dir/data/" fi cd "$dir" || exit - generate_and_print generate_svg "armbianCPU" "svg" "armbianCPU.svg" - generate_and_print generate_markdown "README" md "README.md" - generate_and_print generate_html "index" html "index.html" - generate_and_print generate_html5 "$filename" html "HTML5" - generate_and_print generate_json "$filename" json "JSON" - generate_and_print generate_csv "$filename" csv "CSV" - # May not longer be needed + generate_svg > "$filename.svg" + generate_and_print generate_markdown "../../readme" md "readme.md" + generate_and_print generate_html "../../index" html "index.html" + generate_and_print generate_html5 "index" html "HTML5" + generate_and_print generate_json "data/$filename" json "JSON" + generate_and_print generate_csv "data/${filename%-dev}" csv "CSV" if [[ "$EUID" -eq 0 ]]; then chown -R "$SUDO_USER":"$SUDO_USER" "$(dirname "$dir")" cd ../../ From 025cfca806333076108b49ccd4ec4504d170598d Mon Sep 17 00:00:00 2001 From: Joey Turner Date: Sat, 9 Dec 2023 05:30:46 +0000 Subject: [PATCH 10/10] modified: debian.conf path --- debian.conf | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/debian.conf b/debian.conf index b3aa269f..465e3080 100644 --- a/debian.conf +++ b/debian.conf @@ -1,3 +1,3 @@ -share:/usr/share/doc -lib:/usr/lib/ -bin:/usr/bin/ +share:/usr/ +lib:/usr/ +bin:/usr/