Update README.md and related files with new screenshots and date

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.
+>

bin/README.md

@@ -12,9 +12,11 @@ Utility for configuring your board, divided into four main sections:
 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:
-Thu Apr 11 02:23:43 AM MST 2024.
+Fri Apr 12 01:33:08 AM MST 2024.
 
 ***
 - ## **System** 
@@ -73,9 +75,17 @@ Thu Apr 11 02:23:43 AM MST 2024.
 
 
 ***
+## 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
-get the lastet version of the utility by running the following command:
+## 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

bin/armbian-configng

@@ -10,6 +10,13 @@ tput init
 # allows CTRL c to exit
 trap "exit" INT TERM
 
+if [ "$1" == "-h" ] || [ "$1" == "--help" ]; then
+# TODO : Add help message
+     echo -e "\nComming soon:\nsimple help meassage\n"
+     exit 0 ;
+fi
+
+
 # Get the script directory
 script_dir="$(dirname "$0")" 
 
@@ -25,9 +32,7 @@ json_data=$(cat "$json_file")
 
 
 #
-# We're checking if the 'whiptail' command is available on the system.
 # 'whiptail' is a simple dialog box utility that works well with Bash. It doesn't have all the features of some other dialog box utilities, but it does everything we need for this script.
-# If 'whiptail' is available, we assign its name to the variable DIALOG. This way, we can easily switch to another dialog box utility in the future if we need to, just by changing this one line of code.
 [[ -x "$(command -v whiptail)" ]] && DIALOG="whiptail"
 
 
@@ -67,7 +72,11 @@ Runtime conditions..." | show_infobox ;
 
 fi
 
+
+
+
 tput clear
+
 #
 # Generate the top menu with the modified Object data
 while generate_top_menu "$json_data"; do tput clear ; done

lib/armbian-configng/config.ng.docs.sh

@@ -23,19 +23,20 @@ function generate_readme() {
 #    [[ ! -f "$script_dir/images/logo.svg" ]]  && generate_svg > "$script_dir/images/logo.svg" ;
 
 
+echo "Sorting data\nUpdating documentation" | show_infobox ;
 
+######################################
+# Generate the README.md file   
 echo "$(see_jobs_list)" > "$script_dir/README.md" 
-
-
-
-    echo "Documents have been updated." | show_infobox
+echo "Updating Readme.md" | show_infobox
 
 
 ######################################
 
-echo "Updating WIKI Menu" | show_infobox
-cp  "$script_dir/README.md" "$doc_dir/Home.md"
 
+cp  "$script_dir/README.md" "$doc_dir/Home.md"
+cd "$script_dir" && cp ./README.md "../README.md"
+echo "README.md has been updated." | show_infobox
 
 ######################################
 
@@ -284,7 +285,9 @@ Utility for configuring your board, divided into four main sections:
 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:
 $current_date.
 
@@ -328,9 +331,18 @@ EOF
 
 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
+    
+    armbian-configng --dev
+
+If all goes well you should see the Text-Based User Inerface (TUI)
 
-# Development
-get the lastet version of the utility by running the following command:
+## 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

share/doc/armbian-configng/Home.md

@@ -12,9 +12,11 @@ Utility for configuring your board, divided into four main sections:
 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:
-Thu Apr 11 02:23:43 AM MST 2024.
+Fri Apr 12 01:33:08 AM MST 2024.
 
 ***
 - ## **System** 
@@ -73,9 +75,17 @@ Thu Apr 11 02:23:43 AM MST 2024.
 
 
 ***
+## 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
-get the lastet version of the utility by running the following command:
+## 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