Merge pull request #36 from schwar3kat/patch-1

Fix some typo's
armbian · May 23, 2024 · 722fe9f · 722fe9f
2 parents b4880cd + 79c7e9c
commit 722fe9f
Show file tree

Hide file tree

Showing 18 changed files with 2,590 additions and 261 deletions.
diff --git a/.github/workflows/ftp-deploy.yml.hold b/.github/workflows/ftp-deploy.yml.hold
@@ -0,0 +1,34 @@
+on: push
+name: 🚀 Deploy website on push
+
+jobs:
+  web-deploy:
+    name: 🎉 Deploy
+    runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'Tearran' }}
+    steps:
+    - name: 🚚 Get latest code
+      uses: actions/checkout@v3
+
+    - name: Install ShellCheck
+      run: sudo apt-get install pandoc git shellcheck
+    - name: Run ShellCheck
+      run: |
+        ret=0
+        for file in $(find . -type f -name "*.sh"); do
+          shellcheck --severity=error $file || ret=$?
+        done
+        exit $ret 
+
+    - name: Generate website 
+      run: ./bin/armbian-configng --dev --web
+
+    - name: 📂 Sync files
+      uses: SamKirkland/[email protected]
+      with:
+        server: ${{ secrets.SERVER_HOST}}  # replace with your server
+        username: ${{ secrets.SERVER_USERNAME }}
+        password: ${{ secrets.SERVER_PASSWORD }}     
+        server-dir: / # replace with your server directory
+        local-dir: share/armbian-configng/web/ # replace with your local directory
+
diff --git a/README.md b/README.md
@@ -1,83 +1,100 @@
 
-<p align="center">
-    <img src="https://raw.githubusercontent.com/armbian/build/main/.github/armbian-logo.png" alt="Armbian logo" width="144">
-    <br>
-    Armbian ConfigNG 
-    <br>
-    <a href="https://www.codefactor.io/repository/github/tearran/configng"><img src="https://www.codefactor.io/repository/github/tearran/configng/badge" alt="CodeFactor" /></a>
-</p>
-
-# User guide
+# Armbian configuration utility
+Utility for configuring your board, divided into four main sections:
+
+- System - system and security settings,
+- Network - wired, wireless, Bluetooth, access point,
+- Personal - timezone, language, hostname,
+- Software - system and 3rd party software install.
+
+
+
+To Configure and change global sytem settings, run the following command: `./armbian-configng`
+
+***
+## Screenshots
+![edit-boot-env-2024-04-03 10-06-58](https://github.com/armbian/configng/assets/2831630/448f0515-0854-4a8a-8421-53c8b72bb5c5)
+![BT-connect-2024-04-03 10-06-58](https://github.com/armbian/configng/assets/2831630/fef037ce-346d-4d70-9025-90f69fbdf5d3)
+Following was updated on:
+Fri Apr 12 01:33:08 AM MST 2024.
+
+***
+- ## **System** 
+  - **S01** - Description: Enable Armbina kernal upgrades
+    - Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s01)
+  - **S02** - Description: Disable Armbina kernal upgrades
+    - Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s02)
+  - **S03** - Description: Edit the boot enviroment (WIP)
+    - Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s03)
+
+
+- ## **Network** 
+  - **BT0** - Description: Install Bluetooth support
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#bt0)
+  - **BT1** - Description: Remove Bluetooth support
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#bt1)
+  - **BT3** - Description: Bluetooth Discover
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#bt3)
+  - **IR0** - Description: Install Infrared support
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#ir0)
+  - **IR1** - Description: Uninstall Infrared support
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#ir1)
+  - **N00** - Description: Manage wifi network connections
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#n00)
+  - **N01** - Description: Advanced Edit /etc/network/interface
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#n01)
+  - **N02** - Description: Disconect and forget all wifi connections (Advanced)
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#n02)
+  - **N03** - Description: Toggle system IPv6/IPv4 internet protical
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#n03)
+
+
+- ## **Localisation** 
+  - **L00** - Description: Change Globla timezone (WIP)
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#l00)
+  - **L01** - Description: Change Locales reconfigure the language and charitorset
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#l01)
+  - **L02** - Description: Change Keyboard layout
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#l02)
+  - **L03** - Description: Change APT mirrors
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#l03)
+
+
+- ## **Software** 
+  - **I00** - Description: Update Application Repository
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#i00)
+  - **I01** - Description: CLI System Monitor
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#i01)
+
+
+- ## **Help** 
+  - **H00** - Description: About This systme. (WIP)
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#h00)
+  - **H02** - Description: List of Config function(WIP)
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#h02)
+
+
+***
 ## 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)
 
-### To see a list of all functions and their descriptions, run the following command:
-~~~
-armbian-configng -h
-~~~
-## Coding Style
-follow the following coding style:
+## Development
+Development test brances are available for testing. To clone the development branch, run the following commands:
+
 ~~~
-# @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
-}
+git clone https://github.com/armbian/configng.git
+cd configng
 ~~~
-## 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-06
-## 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:** Benchmarking
- - **Options:** 
- - **Description:** Armbian Monitor and Benchmarking.
 
 
-# Included projects
-- [Bash Utility](https://labbots.github.io/bash-utility) 
-- [Armbian config](https://github.com/armbian/config.git)
 
+## Note:
+>
+> The Bash procedures embedded within the JSON structure are meticulously designed with a focus on clear naming conventions and the simplicity of key pairs. These procedures serve multiple purposes, including facilitating the generation of content in various formats, such as Whiptail, Markdown, json out and others. Moreover, they are utilized for evaluation and execution of commands outlined in the JSON structure.
+>
diff --git a/bin/README.md b/bin/README.md
@@ -0,0 +1,100 @@
+
+# Armbian configuration utility
+Utility for configuring your board, divided into four main sections:
+
+- System - system and security settings,
+- Network - wired, wireless, Bluetooth, access point,
+- Personal - timezone, language, hostname,
+- Software - system and 3rd party software install.
+
+
+
+To Configure and change global sytem settings, run the following command: `./armbian-configng`
+
+***
+## Screenshots
+![edit-boot-env-2024-04-03 10-06-58](https://github.com/armbian/configng/assets/2831630/448f0515-0854-4a8a-8421-53c8b72bb5c5)
+![BT-connect-2024-04-03 10-06-58](https://github.com/armbian/configng/assets/2831630/fef037ce-346d-4d70-9025-90f69fbdf5d3)
+Following was updated on:
+Fri Apr 12 01:33:08 AM MST 2024.
+
+***
+- ## **System** 
+  - **S01** - Description: Enable Armbina kernal upgrades
+    - Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s01)
+  - **S02** - Description: Disable Armbina kernal upgrades
+    - Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s02)
+  - **S03** - Description: Edit the boot enviroment (WIP)
+    - Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s03)
+
+
+- ## **Network** 
+  - **BT0** - Description: Install Bluetooth support
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#bt0)
+  - **BT1** - Description: Remove Bluetooth support
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#bt1)
+  - **BT3** - Description: Bluetooth Discover
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#bt3)
+  - **IR0** - Description: Install Infrared support
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#ir0)
+  - **IR1** - Description: Uninstall Infrared support
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#ir1)
+  - **N00** - Description: Manage wifi network connections
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#n00)
+  - **N01** - Description: Advanced Edit /etc/network/interface
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#n01)
+  - **N02** - Description: Disconect and forget all wifi connections (Advanced)
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#n02)
+  - **N03** - Description: Toggle system IPv6/IPv4 internet protical
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#n03)
+
+
+- ## **Localisation** 
+  - **L00** - Description: Change Globla timezone (WIP)
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#l00)
+  - **L01** - Description: Change Locales reconfigure the language and charitorset
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#l01)
+  - **L02** - Description: Change Keyboard layout
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#l02)
+  - **L03** - Description: Change APT mirrors
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#l03)
+
+
+- ## **Software** 
+  - **I00** - Description: Update Application Repository
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#i00)
+  - **I01** - Description: CLI System Monitor
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#i01)
+
+
+- ## **Help** 
+  - **H00** - Description: About This systme. (WIP)
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#h00)
+  - **H02** - Description: List of Config function(WIP)
+    - Status: [review](https://github.com/armbian/configng/wiki/Menu#h02)
+
+
+***
+## 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
+
+    armbian-configng --dev
+
+If all goes well you should see the Text-Based User Inerface (TUI)
+
+## Development
+Development test brances are available for testing. To clone the development branch, run the following commands:
+
+~~~
+git clone https://github.com/armbian/configng.git
+cd configng
+~~~
+
+
+
+## Note:
+>
+> The Bash procedures embedded within the JSON structure are meticulously designed with a focus on clear naming conventions and the simplicity of key pairs. These procedures serve multiple purposes, including facilitating the generation of content in various formats, such as Whiptail, Markdown, json out and others. Moreover, they are utilized for evaluation and execution of commands outlined in the JSON structure.
+>