Skip to content

Commit 722fe9f

Browse files
TearranTearran
authored
Merge pull request #36 from schwar3kat/patch-1
Fix some typo's
2 parents b4880cd + 79c7e9c commit 722fe9f

File tree

18 files changed

+2590
-261
lines changed

18 files changed

+2590
-261
lines changed

‎.github/workflows/ftp-deploy.yml.hold‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
on: push
2+
name: 🚀 Deploy website on push
3+
4+
jobs:
5+
web-deploy:
6+
name: 🎉 Deploy
7+
runs-on: ubuntu-latest
8+
if: ${{ github.repository_owner == 'Tearran' }}
9+
steps:
10+
- name: 🚚 Get latest code
11+
uses: actions/checkout@v3
12+
13+
- name: Install ShellCheck
14+
run: sudo apt-get install pandoc git shellcheck
15+
- name: Run ShellCheck
16+
run: |
17+
ret=0
18+
for file in $(find . -type f -name "*.sh"); do
19+
shellcheck --severity=error $file || ret=$?
20+
done
21+
exit $ret
22+
23+
- name: Generate website
24+
run: ./bin/armbian-configng --dev --web
25+
26+
- name: 📂 Sync files
27+
uses: SamKirkland/[email protected]
28+
with:
29+
server: ${{ secrets.SERVER_HOST}} # replace with your server
30+
username: ${{ secrets.SERVER_USERNAME }}
31+
password: ${{ secrets.SERVER_PASSWORD }}
32+
server-dir: / # replace with your server directory
33+
local-dir: share/armbian-configng/web/ # replace with your local directory
34+

‎README.md‎

100755100644
Lines changed: 86 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,100 @@
11

2-
<p align="center">
3-
<img src="https://raw.githubusercontent.com/armbian/build/main/.github/armbian-logo.png" alt="Armbian logo" width="144">
4-
<br>
5-
Armbian ConfigNG
6-
<br>
7-
<a href="https://www.codefactor.io/repository/github/tearran/configng"><img src="https://www.codefactor.io/repository/github/tearran/configng/badge" alt="CodeFactor" /></a>
8-
</p>
9-
10-
# User guide
2+
# Armbian configuration utility
3+
Utility for configuring your board, divided into four main sections:
4+
5+
- System - system and security settings,
6+
- Network - wired, wireless, Bluetooth, access point,
7+
- Personal - timezone, language, hostname,
8+
- Software - system and 3rd party software install.
9+
10+
11+
12+
To Configure and change global sytem settings, run the following command: `./armbian-configng`
13+
14+
***
15+
## Screenshots
16+
![edit-boot-env-2024-04-03 10-06-58](https://github.com/armbian/configng/assets/2831630/448f0515-0854-4a8a-8421-53c8b72bb5c5)
17+
![BT-connect-2024-04-03 10-06-58](https://github.com/armbian/configng/assets/2831630/fef037ce-346d-4d70-9025-90f69fbdf5d3)
18+
Following was updated on:
19+
Fri Apr 12 01:33:08 AM MST 2024.
20+
21+
***
22+
- ## **System**
23+
- **S01** - Description: Enable Armbina kernal upgrades
24+
- Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s01)
25+
- **S02** - Description: Disable Armbina kernal upgrades
26+
- Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s02)
27+
- **S03** - Description: Edit the boot enviroment (WIP)
28+
- Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s03)
29+
30+
31+
- ## **Network**
32+
- **BT0** - Description: Install Bluetooth support
33+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#bt0)
34+
- **BT1** - Description: Remove Bluetooth support
35+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#bt1)
36+
- **BT3** - Description: Bluetooth Discover
37+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#bt3)
38+
- **IR0** - Description: Install Infrared support
39+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#ir0)
40+
- **IR1** - Description: Uninstall Infrared support
41+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#ir1)
42+
- **N00** - Description: Manage wifi network connections
43+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#n00)
44+
- **N01** - Description: Advanced Edit /etc/network/interface
45+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#n01)
46+
- **N02** - Description: Disconect and forget all wifi connections (Advanced)
47+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#n02)
48+
- **N03** - Description: Toggle system IPv6/IPv4 internet protical
49+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#n03)
50+
51+
52+
- ## **Localisation**
53+
- **L00** - Description: Change Globla timezone (WIP)
54+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#l00)
55+
- **L01** - Description: Change Locales reconfigure the language and charitorset
56+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#l01)
57+
- **L02** - Description: Change Keyboard layout
58+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#l02)
59+
- **L03** - Description: Change APT mirrors
60+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#l03)
61+
62+
63+
- ## **Software**
64+
- **I00** - Description: Update Application Repository
65+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#i00)
66+
- **I01** - Description: CLI System Monitor
67+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#i01)
68+
69+
70+
- ## **Help**
71+
- **H00** - Description: About This systme. (WIP)
72+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#h00)
73+
- **H02** - Description: List of Config function(WIP)
74+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#h02)
75+
76+
77+
***
1178
## Quick start
1279
Run the following commands:
1380

14-
echo "deb [signed-by=/usr/share/keyrings/armbian.gpg] https://armbian.github.io/configng stable main" \
15-
| sudo tee /etc/apt/sources.list.d/armbian-development.list > /dev/null
81+
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
1682

1783
armbian-configng --dev
1884

1985
If all goes well you should see the Text-Based User Inerface (TUI)
2086

21-
### To see a list of all functions and their descriptions, run the following command:
22-
~~~
23-
armbian-configng -h
24-
~~~
25-
## Coding Style
26-
follow the following coding style:
87+
## Development
88+
Development test brances are available for testing. To clone the development branch, run the following commands:
89+
2790
~~~
28-
# @description A short description of the function.
29-
#
30-
# @exitcode 0 If successful.
31-
#
32-
# @options A description if there are options.
33-
function group::string() {s
34-
echo "hello world"
35-
return 0
36-
}
91+
git clone https://github.com/armbian/configng.git
92+
cd configng
3793
~~~
38-
## Codestyle can be used to auto generate
39-
- [Markdown](share/armbian-configng/readme.md)
40-
- [JSON](share/armbian-configng/data/armbian-configng.json)
41-
- [CSV](share/armbian-configng/data/armbian-configng.csv)
42-
- [HTML](share/armbian-configng/armbian-configng-table.html)
43-
- [github.io](//tearran/github.io/armbian-configng/index.html)
44-
## Functions list as of 2023-12-06
45-
## network
46-
System and Security
47-
48-
### set_wifi.sh
49-
50-
- **Group Name:** network
51-
- **Action Name:** NMTUI
52-
- **Options:** none.
53-
- **Description:** Network Manager.
54-
55-
## system
56-
Network Wired wireless Bluetooth access point
57-
58-
### armbian_install.sh
59-
60-
- **Group Name:** system
61-
- **Action Name:** Install
62-
- **Options:** none
63-
- **Description:** Armbian installer.
64-
65-
### hello_world.sh
66-
67-
- **Group Name:** system
68-
- **Action Name:** Hello
69-
- **Options:** none
70-
- **Description:** Hello System.
71-
72-
### see_monitor.sh
73-
74-
- **Group Name:** monitor
75-
- **Action Name:** Benchmarking
76-
- **Options:**
77-
- **Description:** Armbian Monitor and Benchmarking.
7894

7995

80-
# Included projects
81-
- [Bash Utility](https://labbots.github.io/bash-utility)
82-
- [Armbian config](https://github.com/armbian/config.git)
8396

97+
## Note:
98+
>
99+
> 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.
100+
>

‎bin/README.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
2+
# Armbian configuration utility
3+
Utility for configuring your board, divided into four main sections:
4+
5+
- System - system and security settings,
6+
- Network - wired, wireless, Bluetooth, access point,
7+
- Personal - timezone, language, hostname,
8+
- Software - system and 3rd party software install.
9+
10+
11+
12+
To Configure and change global sytem settings, run the following command: `./armbian-configng`
13+
14+
***
15+
## Screenshots
16+
![edit-boot-env-2024-04-03 10-06-58](https://github.com/armbian/configng/assets/2831630/448f0515-0854-4a8a-8421-53c8b72bb5c5)
17+
![BT-connect-2024-04-03 10-06-58](https://github.com/armbian/configng/assets/2831630/fef037ce-346d-4d70-9025-90f69fbdf5d3)
18+
Following was updated on:
19+
Fri Apr 12 01:33:08 AM MST 2024.
20+
21+
***
22+
- ## **System**
23+
- **S01** - Description: Enable Armbina kernal upgrades
24+
- Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s01)
25+
- **S02** - Description: Disable Armbina kernal upgrades
26+
- Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s02)
27+
- **S03** - Description: Edit the boot enviroment (WIP)
28+
- Status: [WIP](https://github.com/armbian/configng/wiki/Menu#s03)
29+
30+
31+
- ## **Network**
32+
- **BT0** - Description: Install Bluetooth support
33+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#bt0)
34+
- **BT1** - Description: Remove Bluetooth support
35+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#bt1)
36+
- **BT3** - Description: Bluetooth Discover
37+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#bt3)
38+
- **IR0** - Description: Install Infrared support
39+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#ir0)
40+
- **IR1** - Description: Uninstall Infrared support
41+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#ir1)
42+
- **N00** - Description: Manage wifi network connections
43+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#n00)
44+
- **N01** - Description: Advanced Edit /etc/network/interface
45+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#n01)
46+
- **N02** - Description: Disconect and forget all wifi connections (Advanced)
47+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#n02)
48+
- **N03** - Description: Toggle system IPv6/IPv4 internet protical
49+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#n03)
50+
51+
52+
- ## **Localisation**
53+
- **L00** - Description: Change Globla timezone (WIP)
54+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#l00)
55+
- **L01** - Description: Change Locales reconfigure the language and charitorset
56+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#l01)
57+
- **L02** - Description: Change Keyboard layout
58+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#l02)
59+
- **L03** - Description: Change APT mirrors
60+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#l03)
61+
62+
63+
- ## **Software**
64+
- **I00** - Description: Update Application Repository
65+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#i00)
66+
- **I01** - Description: CLI System Monitor
67+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#i01)
68+
69+
70+
- ## **Help**
71+
- **H00** - Description: About This systme. (WIP)
72+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#h00)
73+
- **H02** - Description: List of Config function(WIP)
74+
- Status: [review](https://github.com/armbian/configng/wiki/Menu#h02)
75+
76+
77+
***
78+
## Quick start
79+
Run the following commands:
80+
81+
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
82+
83+
armbian-configng --dev
84+
85+
If all goes well you should see the Text-Based User Inerface (TUI)
86+
87+
## Development
88+
Development test brances are available for testing. To clone the development branch, run the following commands:
89+
90+
~~~
91+
git clone https://github.com/armbian/configng.git
92+
cd configng
93+
~~~
94+
95+
96+
97+
## Note:
98+
>
99+
> 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.
100+
>

0 commit comments

Comments
 (0)