Skip to content

Commit 5274190

Browse files
authored
Improve armbian config main README.md file (#649)
1 parent 6bffeaa commit 5274190

File tree

1 file changed

+49
-74
lines changed

1 file changed

+49
-74
lines changed

README.md

Lines changed: 49 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,38 @@
1-
<p align="center">
2-
<a href="#build-framework">
3-
<img src="https://raw.githubusercontent.com/armbian/configng/main/share/icons/hicolor/scalable/configng-tux.svg" width="128" alt="Armbian Config NG Logo" />
4-
</a><br>
5-
<strong>Armbian Config: The Next Generation</strong><br>
6-
<br>
7-
<a href=https://github.com/armbian/configng/actions/workflows/debian.yml><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/armbian/configng/debian.yml?logo=githubactions&label=Packaging&style=for-the-badge&branch=main"></a> <a href=https://github.com/armbian/configng/actions/workflows/unit-tests.yml><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/armbian/configng/unit-tests.yml?logo=githubactions&label=Unit%20tests&style=for-the-badge&branch=main"></a> <a href=https://github.com/armbian/configng/actions/workflows/docs.yml><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/armbian/configng/docs.yml?logo=githubactions&label=Documentation&style=for-the-badge&branch=main"></a>
8-
</p>
1+
<h2 align="center">
2+
<img src="https://raw.githubusercontent.com/armbian/.github/master/profile/logo.png" alt="Armbian logo" width="25%">
3+
<br><br>
4+
</h2>
5+
6+
### Purpose of This Repository
7+
8+
This repository contains the source code for **Armbian Config**, a versatile and extremly **lightweight configuration utility** designed to simplify and automate common system tasks within the Armbian Linux environment.
9+
10+
Armbian Config provides interactive and scriptable routines for:
911

10-
Armbian config provides configuration and installation routines for customizing and automating tasks within Armbian Linux environment. These utilities help streamline setup processes for various use cases.
12+
- Initial system setup and personalization
13+
- Networking configuration, including Wi-Fi, VPN, and static IP
14+
- Sandboxed software installation and system updates
15+
- Kernel selection, switching, and firmware management
16+
- Enabling and managing hardware-specific features
1117

12-
## Getting Started
18+
It is especially useful for single board computers (SBCs), helping users quickly prepare a ready-to-use system without manual intervention.
1319

14-
Armbian config comes preinstalled with Armbian. To get started, open a terminal or log in via SSH, then run:
20+
### Quick Start
21+
22+
Armbian Config comes **preinstalled** with Armbian images.
23+
24+
To launch the utility:
25+
26+
1. Open a terminal (locally or via SSH)
27+
2. Run the following command:
1528

1629
```bash
1730
armbian-config
1831
```
1932

2033
<a href=#><img src=.github/images/common.png></a>
2134

22-
## Key Advantages
23-
- **Lightweight**: Minimal dependencies for optimal performance.
24-
- **Flexible**: Supports JSON, TUI, CLI, and API interfaces.
25-
- **Modern**: A fresh approach to configuration.
26-
- **Low entropy**: Byte clean uninstall for most targets.
27-
28-
## Features
29-
30-
- **System Configuration**:
31-
- Kernel management, headers, hardware tweaks.
32-
- NFS and ZFS storage management.
33-
- SSH user access tweaks.
34-
- System updates, rolling / stable, containers update.
35-
- **Network Management**:
36-
- Fixed / dynamic IP configuration.
37-
- Connecting to wireless network.
38-
- Access point management.
39-
- **Localization Settings**:
40-
- Configure time zone.
41-
- Set language and locales.
42-
- Change hostname.
43-
- **Software Management**:
44-
- Software installation and removal.
45-
- Native and containerized environment.
46-
- Standardised, updatable, maintained.
47-
48-
## Compatibility
35+
### Compatibility
4936

5037
This tool is optimized for use with [**Armbian Linux**](https://www.armbian.com), but in theory, it should also work on any systemd-based, APT-compatible Linux distribution — including Linux Mint, Elementary OS, Kali Linux, MX Linux, Parrot OS, Proxmox, Raspberry Pi OS, and others.
5138
<details><summary>Add Armbian key + repository and install the tool:</summary>
@@ -62,56 +49,44 @@ Signed-By: /usr/share/keyrings/armbian.gpg
6249
EOF
6350
sudo apt update
6451
sudo apt -y install armbian-config
65-
```
66-
67-
```bash
6852
armbian-config
6953
```
7054
</details>
7155

72-
## Contributing
56+
### Contribute
7357

74-
<a href="https://github.com/armbian/configng/graphs/contributors">
75-
<img src="https://contrib.rocks/image?repo=armbian/configng" />
76-
</a>
77-
<br>
78-
<br>
58+
Want to expand **Armbian Config** with new features or tools? Whether you're adding a new software title, enhancing an existing configuration module, or introducing entirely new functionality, we welcome your ideas and code.
7959

80-
Thank you to everyone who has contributed to **Armbian-config** — your efforts are deeply appreciated!
81-
82-
#### General
83-
84-
Contributions are welcome in many forms:
85-
86-
- 🐞 [Report bugs](https://github.com/armbian/configng/issues)
87-
- 📚 [Improve documentation](https://docs.armbian.com/)
88-
- 🛠️ [Fix or enhance code](https://github.com/armbian/configng/pulls)
89-
90-
Please read our [CONTRIBUTING.md](./CONTRIBUTING.md) before getting started.
91-
92-
#### Adding or configuring functionality
60+
<https://docs.armbian.com/Contribute/Armbian-config>
9361

94-
Want to expand Armbian-config with new features or tools? Whether you're adding a new software title, enhancing an existing configuration module, or introducing entirely new functionality, we welcome your ideas and code.
62+
> 📌 Tip: Keep your changes modular and easy to maintain — this helps us review and merge your contribution faster.
9563
96-
To get started:
64+
### Support
9765

98-
- Review how similar features are implemented in the current codebase.
99-
- Follow the structure and coding style used in existing modules.
100-
- Ensure your additions are well-tested and don’t break existing functionality.
101-
- Document any new options clearly so users understand how to use them.
66+
Armbian offers multiple support channels, depending on your needs:
10267

103-
<https://docs.armbian.com/Contribute/Armbian-config>
68+
- **Community Forums**
69+
Get help from fellow users and contributors on a wide range of topics — from troubleshooting to development.
70+
👉 [forum.armbian.com](https://forum.armbian.com)
10471

105-
> 📌 Tip: Keep your changes modular and easy to maintain — this helps us review and merge your contribution faster.
72+
- **Discord / IRC / Matrix Chat**
73+
Join real-time discussions with developers and community members for faster feedback and collaboration.
74+
👉 [Community Chat](https://docs.armbian.com/Community_IRC/)
10675

107-
#### 💖 Donating
76+
- **Paid Consultation**
77+
For advanced needs, commercial projects, or guaranteed response times, paid support is available directly from Armbian maintainers.
78+
👉 [Contact us](https://www.armbian.com/contact) to discuss consulting options.
10879

109-
Not a developer? You can still make a big impact! Your donations help us maintain infrastructure, test hardware, and improve development workflows.
80+
### Contributors
11081

111-
[Support the project here](https://github.com/sponsors/armbian)
82+
Thanks to all who have contributed to Armbian Config!
11283

113-
## License
84+
<a href="https://github.com/armbian/configng/graphs/contributors">
85+
<img src="https://contrib.rocks/image?repo=armbian/configng" />
86+
</a>
87+
<br>
88+
<br>
11489

115-
(c) [Contributors](https://github.com/armbian/configng/graphs/contributors)
90+
### Armbian Partners
11691

117-
All code is licensed under the GPL, v3 or later. See [LICENSE](LICENSE) file for details.
92+
Armbian's [partnership program](https://forum.armbian.com/subscriptions) helps to support Armbian and the Armbian community! Please take a moment to familiarize yourself with [our Partners](https://armbian.com/partners).

0 commit comments

Comments
 (0)