Update README.md: Separate End-User from Developer Documentation,

User-Guide_Armbian-ConfigNG.md

@@ -0,0 +1,140 @@
+
+# Armbian Configuration Utility
+Utility for configuring your board, adjusting services, and installing applications. 
+
+## Sections
+Armbian-configng is divided into four main sections:
+- System - system and security settings,
+- Network - wired, wireless, Bluetooth, access point,
+- Localisation - timezone, language, hostname,
+- Software - system and 3rd party software install.
+
+## Install latest release
+~~~
+{
+    sudo apt install whiptail
+    latest_release=$(curl -s https://api.github.com/repos/armbian/configng/releases/latest)
+    deb_url=$(echo "$latest_release" | jq -r '.assets[] | select(.name | endswith(".deb")) | .browser_download_url')
+    curl -LO "$deb_url"
+    deb_file=$(echo "$deb_url" | awk -F"/" '{print $NF}')
+    sudo dpkg -i "$deb_file"
+    sudo dpkg --configure -a
+    sudo apt --fix-broken install
+}
+~~~
+
+Armbian_config requires root privilege. To start the Armbian configuration utility, use the following sudo "super user do" command:
+~~~
+sudo armbian-configng
+~~~
+
+## list of features
+Updated: Thu Aug  8 11:47:36 PM EDT 2024
+
+- ### **System** 
+  - **S01** - Enable Armbian kernel upgrades
+  - **S02** - Disable Armbian kernel upgrades
+  - **S03** - Edit the boot environment
+  - **S04** - Install Linux headers
+  - **S05** - Remove Linux headers
+
+
+- ### **Network** 
+  - **N00** - Install Bluetooth support
+  - **N01** - Remove Bluetooth support
+  - **N02** - Bluetooth Discover
+  - **N03** - Install Infrared support
+  - **N04** - Uninstall Infrared support
+  - **N05** - Manage wifi network connections
+  - **N06** - Advanced Edit /etc/network/interface
+  - **N07** - Disconnect and forget all wifi connections (Advanced)
+  - **N08** - Toggle system IPv6/IPv4 internet protocol
+  - **N09** - (WIP) Setup Hotspot/Access point
+  - **N10** - Announce system in the network (Avahi) 
+  - **N11** - Disable system announce in the network (Avahi) 
+
+
+- ### **Localisation** 
+  - **L00** - Change Global timezone (WIP)
+  - **L01** - Change Locales reconfigure the language and character set
+  - **L02** - Change Keyboard layout
+  - **L03** - Change APT mirrors
+
+
+- ### **Software** 
+  - **I00** - Update Application Repository
+  - **I01** - CLI System Monitor
+
+
+- ### **Help** 
+  - **H00** - About This system. (WIP)
+  - **H02** - List of Config function(WIP)
+
+
+***
+
+## CLI options
+Command line options.
+
+Use:
+~~~
+armbian-configng --help
+~~~
+
+Outputs:
+~~~
+Usage:  armbian-configng [option] [arguments]
+
+    --help      -  Display this help message.
+    main=Help   -  Display Legacy Options (Backward Compatible)
+
+    --cli S01  -  Enable Armbian kernel upgrades
+    --cli S02  -  Disable Armbian kernel upgrades
+    --cli S03  -  Edit the boot environment
+    --cli S04  -  Install Linux headers
+    --cli S05  -  Remove Linux headers
+    --cli N00  -  Install Bluetooth support
+    --cli N01  -  Remove Bluetooth support
+    --cli N02  -  Bluetooth Discover
+    --cli N03  -  Install Infrared support
+    --cli N04  -  Uninstall Infrared support
+    --cli N05  -  Manage wifi network connections
+    --cli N06  -  Advanced Edit /etc/network/interface
+    --cli N07  -  Disconnect and forget all wifi connections (Advanced)
+    --cli N08  -  Toggle system IPv6/IPv4 internet protocol
+    --cli N09  -  (WIP) Setup Hotspot/Access point
+    --cli N10  -  Announce system in the network (Avahi) 
+    --cli N11  -  Disable system announce in the network (Avahi) 
+    --cli L00  -  Change Global timezone (WIP)
+    --cli L01  -  Change Locales reconfigure the language and character set
+    --cli L02  -  Change Keyboard layout
+    --cli L03  -  Change APT mirrors
+    --cli I00  -  Update Application Repository
+    --cli I01  -  CLI System Monitor
+~~~
+
+## Legacy options
+Backward Compatible options.
+
+Use:
+~~~
+armbian-configng main=Help
+~~~
+
+Outputs:
+~~~
+Legacy Options (Backward Compatible)
+Please use 'armbian-configng --help' for more information.
+
+Usage:  armbian-configng main=[arguments] selection=[options]
+
+    armbian-configng main=System selection=Headers          -  Install headers:                                        
+    armbian-configng main=System selection=Headers_remove   -  Remove headers:                                 
+~~~
+
+***
+
+Sources
+
+https://github.com/armbian/configng
+

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

@@ -25,37 +25,42 @@ function generate_readme() {
 echo -e "Sorting data\nUpdating documentation" # current_date ;
 
 
-cat << EOF > "$script_dir/../README.md"
+cat << EOF > "$script_dir/../User-Guide_Armbian-ConfigNG.md"
 
 # Armbian Configuration Utility
-Updated: $current_date
+Utility for configuring your board, adjusting services, and installing applications. 
 
-Utility for configuring your board, adjusting services, and installing applications. It comes with Armbian by default.
+## Sections
+Armbian-configng is divided into four main sections:
+- System - system and security settings,
+- Network - wired, wireless, Bluetooth, access point,
+- Localisation - timezone, language, hostname,
+- Software - system and 3rd party software install.
 
-To start the Armbian configuration utility, use the following command:
+## Install latest release
 ~~~
-sudo armbian-config
+{
+    sudo apt install whiptail
+    latest_release=\$(curl -s https://api.github.com/repos/armbian/configng/releases/latest)
+    deb_url=\$(echo "\$latest_release" | jq -r '.assets[] | select(.name | endswith(".deb")) | .browser_download_url')
+    curl -LO "\$deb_url"
+    deb_file=\$(echo "\$deb_url" | awk -F"/" '{print \$NF}')
+    sudo dpkg -i "\$deb_file"
+    sudo dpkg --configure -a
+    sudo apt --fix-broken install
+}
 ~~~
 
-$(see_full_list)
-
-## Install 
-Armbian installation 
+Armbian_config requires root privilege. To start the Armbian configuration utility, use the following sudo "super user do" command:
 ~~~
-sudo apt install armbian-config
+sudo armbian-configng
 ~~~
 
-3rd party Debian based distributions
-~~~
-{
-    sudo wget https://apt.armbian.com/armbian.key -O key
-    sudo gpg --dearmor < key | sudo tee /usr/share/keyrings/armbian.gpg > /dev/null
-    sudo chmod go+r /usr/share/keyrings/armbian.gpg
-    sudo echo "deb [arch=\$(dpkg --print-architecture) signed-by=/usr/share/keyrings/armbian.gpg] http://apt.armbian.com \$(lsb_release -cs) main  \$(lsb_release -cs)-utils  \$(lsb_release -cs)-desktop" | sudo tee /etc/apt/sources.list.d/armbian.list
-    sudo apt update
-    sudo apt install armbian-config
-}
-~~~
+## list of features
+Updated: $current_date
+
+$(see_full_list)
+
 
 ***
 
@@ -64,7 +69,7 @@ Command line options.
 
 Use:
 ~~~
-armbian-config --help
+armbian-configng --help
 ~~~
 
 Outputs:
@@ -77,7 +82,7 @@ Backward Compatible options.
 
 Use:
 ~~~
-armbian-config main=Help
+armbian-configng main=Help
 ~~~
 
 Outputs:
@@ -87,81 +92,13 @@ $(see_cli_legacy)
 
 ***
 
-## Development
-
-Development is divided into three sections:
-
-Click for more info:
-
-<details>
-<summary><b>Jobs / JSON Object</b></summary>
-
-A list of the jobs defined in the Jobs file.
-
- $(see_jq_menu_list)
-
-</details>
-
-
-<details>
-<summary><b>Jobs API / Helper Functions</b></summary>
-
-These helper functions facilitate various operations related to job management, such as creation, updating, deletion, and listing of jobs, acting as a practical API for developers.
-
-$(see_function_table_md)
-
+Sources
 
-</details>
+https://github.com/armbian/configng
 
+EOF
 
-<details>
-<summary><b>Runtime / Board Statuses</b></summary>
-
-(WIP)
-
-This section outlines the runtime environment to check configurations and statuses for dynamically managing jobs based on JSON data.
-
-(WIP)
-
-</details>
-
-
-## Testing and contributing
-
-<details>
-<summary><b>Get Development</b></summary>
-
-Install the dependencies:
-~~~
-sudo apt install git jq whiptail
-~~~
-
-Get Development and contribute:
-~~~
-{
-    git clone https://github.com/armbian/configng
-    cd configng
-    ./armbian-configng --help
-}
-~~~
-
-Install and test Development deb:
-~~~
-{
-    sudo apt install whiptail
-    latest_release=\$(curl -s https://api.github.com/repos/armbian/configng/releases/latest)
-    deb_url=\$(echo "\$latest_release" | jq -r '.assets[] | select(.name | endswith(".deb")) | .browser_download_url')
-    curl -LO "\$deb_url"
-    deb_file=\$(echo "\$deb_url" | awk -F"/" '{print \$NF}')
-    sudo dpkg -i "\$deb_file"
-    sudo dpkg --configure -a
-    sudo apt --fix-broken install
-}
-~~~
-
-</details>
 
-EOF
 
 }
 
@@ -375,7 +312,7 @@ function see_full_list() {
         cat=$(jq -r ".menu[$i].id" "$json_file")
         description=$(jq -r ".menu[$i].description" "$json_file")
 
-        echo -e "- ## **$cat** "
+        echo -e "- ### **$cat** "
         #echo   "$description"
 
         sub_items=$(jq -r ".menu[$i].sub | length" "$json_file")
@@ -507,7 +444,7 @@ function see_cli_legacy() {
         local script_name=$(basename "$0")
         cat << EOF 
 Legacy Options (Backward Compatible)
-Please use 'armbian-config --help' for more information.
+Please use 'armbian-configng --help' for more information.
 
 Usage:  $script_name main=[arguments] selection=[options]