mirror of
https://github.com/armbian/configng.git
synced 2026-01-06 10:37:41 -08:00
Adjust quick install guide since we are making a repository on the fly (#21)
* 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>
This commit is contained in:
11
README.md
11
README.md
@@ -11,17 +11,16 @@
|
||||
## Quick start
|
||||
Run the following commands:
|
||||
|
||||
sudo apt install git
|
||||
cd ~/
|
||||
git clone https://github.com/armbian/configng.git
|
||||
cd configng
|
||||
./bin/armbian-configng --dev
|
||||
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:
|
||||
~~~
|
||||
bash ~/configng/bin/armbian-configng -h
|
||||
armbian-configng -h
|
||||
~~~
|
||||
## Coding Style
|
||||
follow the following coding style:
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
share:/usr/share/doc
|
||||
lib:/usr/lib/
|
||||
bin:/usr/bin/
|
||||
share:/usr/
|
||||
lib:/usr/
|
||||
bin:/usr/
|
||||
|
||||
@@ -2,3 +2,4 @@ Function Name,Group Name,Description,Options,Category,Category Description
|
||||
NMTUI,network,Network Manager.,none.,network,Network Wired wireless Bluetooth access point
|
||||
Hello,system,Hello System.,none,system,System and Security
|
||||
Bencharking,monitor,Armbian Monitor and Bencharking.,,system,System and Security
|
||||
Install,system,Armbian installer,none.,system,System and Security
|
||||
|
@@ -3,7 +3,7 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Armbian index </title>
|
||||
Armbian armbian-configng </title>
|
||||
<style>
|
||||
body {
|
||||
font-family: Arial, sans-serif;
|
||||
@@ -26,7 +26,7 @@
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<h1>index</h1>
|
||||
<h1>armbian-configng</h1>
|
||||
</header>
|
||||
<nav>
|
||||
<ul>
|
||||
@@ -69,6 +69,14 @@
|
||||
"Options": "",
|
||||
"Category": "system",
|
||||
"Category Description": "System and Security"
|
||||
},
|
||||
{
|
||||
"Function Name": "Install",
|
||||
"Group Name": "system",
|
||||
"Description": "Armbian installer",
|
||||
"Options": "none.",
|
||||
"Category": "system",
|
||||
"Category Description": "System and Security"
|
||||
}
|
||||
] ;
|
||||
var data = jsonData;
|
||||
@@ -22,5 +22,13 @@
|
||||
"Options": "",
|
||||
"Category": "system",
|
||||
"Category Description": "System and Security"
|
||||
},
|
||||
{
|
||||
"Function Name": "Install",
|
||||
"Group Name": "system",
|
||||
"Description": "Armbian installer",
|
||||
"Options": "none.",
|
||||
"Category": "system",
|
||||
"Category Description": "System and Security"
|
||||
}
|
||||
]
|
||||
0
share/armbian-configng/armbian-configng.svg → share/doc/armbian-configng/armbianCPU.svg
Normal file → Executable file
0
share/armbian-configng/armbian-configng.svg → share/doc/armbian-configng/armbianCPU.svg
Normal file → Executable file
|
Before Width: | Height: | Size: 9.0 KiB After Width: | Height: | Size: 9.0 KiB |
42
share/doc/armbian-configng/index.html
Executable file
42
share/doc/armbian-configng/index.html
Executable file
@@ -0,0 +1,42 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<style>
|
||||
body {
|
||||
background-color: #333;
|
||||
color: #fff;
|
||||
font-family: Arial, sans-serif;
|
||||
}
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
width: 100%;
|
||||
}
|
||||
th, td {
|
||||
text-align: left;
|
||||
padding: 8px;
|
||||
}
|
||||
th {
|
||||
background-color: #4CAF50;
|
||||
color: white;
|
||||
}
|
||||
tr:nth-child(even) {color: black; background-color: #f2f2f2; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Function Name</th>
|
||||
<th>Group Name</th>
|
||||
<th>Description</th>
|
||||
<th>Options</th>
|
||||
<th>Category</th>
|
||||
<th>Category Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr><td>NMTUI</td><td>network</td><td>Network Manager.</td><td>none.</td><td>network</td><td>Network Wired wireless Bluetooth access point</td></tr><tr><td>Hello</td><td>system</td><td>Hello System.</td><td>none</td><td>system</td><td>System and Security</td></tr><tr><td>Bencharking</td><td>monitor</td><td>Armbian Monitor and Bencharking.</td><td></td><td>system</td><td>System and Security</td></tr><tr><td>Install</td><td>system</td><td>Armbian installer</td><td>none.</td><td>system</td><td>System and Security</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user