From ac7ae34ddb91ef1de8f454156097a9cd1a5bf30a Mon Sep 17 00:00:00 2001 From: Tearran Date: Wed, 3 Apr 2024 19:27:49 -0700 Subject: [PATCH] reverted readme --- README.md | 178 ++++++++++++++++++++---------------------------------- 1 file changed, 66 insertions(+), 112 deletions(-) mode change 100644 => 100755 README.md diff --git a/README.md b/README.md old mode 100644 new mode 100755 index c028e85a2..b3e4cb1d5 --- a/README.md +++ b/README.md @@ -1,129 +1,83 @@ -# Armbian configuration utility -Utility for configuring your board, adjusting services and installing applications. - - - - - - - - -*** -# Installation: -Development version: -~~~ -git clone https://github.com/armbian/configng.git -cd configng +

+ 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 + + 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: ~~~ - -# Systme administrators -To Configure and change global sytem settings, run the following command: -~~~ -sudo ./armbian-configng +armbian-configng -h ~~~ - -# Start as non-root user -To use the utility as a user, run the following command: +## Coding Style +follow the following coding style: ~~~ -./armbian-configng +# @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-06 +## network +System and Security -*** - -Following was Generated on: -Wed Apr 3 12:11:35 PM MST 2024. - -*** - -# Armbian-configng Menu table - - - -## Development - -Prosedures Testing grounds (WIP) - -| Job ID | Description | Contributor | Reference | Documents | Status | -|:------ | ----------- | ----------- | --------- | --------- | ------:| -| T00 | Check Colors (beta) | Tearran | X | [Document](https://github.com/armbian/configng/wiki/Interface) | Ref or doc Needed | -| T01 | Chack if apt up to date (beta) | Tearran | X | X | Ref or doc Needed | -| T02 | Example Yes/NO, OK message box (stable) | Tearran | X | [Document](https://github.com/armbian/configng/wiki/Interface) | Ref or doc Needed | -| T03 | Remove kernel headers | | X | X | Ref or doc Needed | -| T04 | Install kernel headers | | X | X | Ref or doc Needed | - - -## System - -System wide and admin settings - -| Job ID | Description | Contributor | Reference | Documents | Status | -|:------ | ----------- | ----------- | --------- | --------- | ------:| -| S01 | Enable Armbina kernal upgrades | | X | X | Ref or doc Needed | -| S02 | Disable Armbina kernal upgrades | | X | X | Ref or doc Needed | -| S03 | Edit the boot enviroment (WIP) | | X | X | Ref or doc Needed | - - -## Network - -Wireless, Ethernet, and Network settings - -| Job ID | Description | Contributor | Reference | Documents | Status | -|:------ | ----------- | ----------- | --------- | --------- | ------:| -| N00 | Manage wifi network connections | | X | X | Ref or doc Needed | -| BT0 | Install Bluetooth support | | X | X | Ref or doc Needed | -| BT1 | Remove Bluetooth support | | X | X | Ref or doc Needed | -| BT3 | Bluetooth Discover | | X | X | Ref or doc Needed | -| IR1 | Remove Infrared support | | [Reference](./README.md#L#30) | X | Ref or doc Needed | -| IR0 | Install Infrared support | | X | X | Ref or doc Needed | -| N05 | Advanced Edit /etc/network/interface | | X | X | Ref or doc Needed | -| N06 | Disconect and forget all wifi connections (Advanced) | | X | X | Ref or doc Needed | - - -## Localisation - -Localisation - -| Job ID | Description | Contributor | Reference | Documents | Status | -|:------ | ----------- | ----------- | --------- | --------- | ------:| -| L00 | Change Globla timezone (WIP) | | X | X | Ref or doc Needed | -| L01 | Change Locales reconfigure the language environment | | X | X | Ref or doc Needed | -| L02 | Change Keyboard layout | | X | X | Ref or doc Needed | -| L03 | Change APT mirrors | | X | X | Ref or doc Needed | - - -## Software - -Run/Install 3rd party apllications +### set_wifi.sh -| Job ID | Description | Contributor | Reference | Documents | Status | -|:------ | ----------- | ----------- | --------- | --------- | ------:| -| I00 | Update Application Repository | | X | X | Ref or doc Needed | -| I01 | CLI System Monitor | | X | X | Ref or doc Needed | + - **Group Name:** network + - **Action Name:** NMTUI + - **Options:** none. + - **Description:** Network Manager. +## system +Network Wired wireless Bluetooth access point -## Downloads +### armbian_install.sh -Run/Download 3rd party apllications + - **Group Name:** system + - **Action Name:** Install + - **Options:** none + - **Description:** Armbian installer. -| Job ID | Description | Contributor | Reference | Documents | Status | -|:------ | ----------- | ----------- | --------- | --------- | ------:| -| D00 | CLI System Monitor | | X | X | Ref or doc Needed | +### hello_world.sh + - **Group Name:** system + - **Action Name:** Hello + - **Options:** none + - **Description:** Hello System. -## Help +### see_monitor.sh -About this app + - **Group Name:** monitor + - **Action Name:** Benchmarking + - **Options:** + - **Description:** Armbian Monitor and Benchmarking. -| Job ID | Description | Contributor | Reference | Documents | Status | -|:------ | ----------- | ----------- | --------- | --------- | ------:| -| H00 | About This systme. (WIP) | | X | X | Ref or doc Needed | -| H02 | List of Config function(WIP) | | X | X | Ref or doc Needed | -*** -## 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, with an emphasis on ease of translation or interpretation for compatibility with different naming conventions, particularly for language files. These procedures serve multiple purposes, including facilitating the generation of content in various formats, such as Whiptail, YAML, Markdown, and others. Moreover, they are utilized for evaluation and execution of commands outlined in the JSON structure. -> -> By adhering to consistent naming conventions and emphasizing the simplicity of key pairs, the application aims to streamline the output generation process. This approach attemps to enhances the versatility and usability of the application, accommodating different preferences for data formats and enabling direct execution of specified commands. +# Included projects +- [Bash Utility](https://labbots.github.io/bash-utility) +- [Armbian config](https://github.com/armbian/config.git)