mirror of
https://github.com/armbian/configng.git
synced 2026-01-06 10:37:41 -08:00
6f9b8056d1517eee52fa6ab9ef01263aa7423e4d
* Update Quick start
After verifying if we put it into wanted folders and if it works, automation builds upon changes.
* Update README.md
* Update README.md
* Updated readme.md function to redirect to /share/doc/README.md
* Run doc gen
* RM genterated documents folder
* bin/armbian-configng --dev --doc codespace
* deleted: share/doc/armbian-configng/README.md
* Revert "Updated readme.md function to redirect to /share/doc/README.md"
This reverts commit db6f4f4034.
* modified: debian.conf path
---------
Co-authored-by: Joey Turner <Tearran@users.noreply.github.com>
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:
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
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: Bencharking
- Options:
- Description: Armbian Monitor and Bencharking.
Inclueded projects
Languages
Shell
97.7%
Python
2.3%
