Armbian Build Framework Script [DOC-1]

[Tearran]

Pull Request Description

Documentation-Focused: Armbian Build Framework

Overview

This pull request introduces a user-friendly script that acts as a bridge to interact with the Armbian Build Framework. Its main goal is to enhance accessibility and facilitate communication for users who may not be familiar with the underlying script.

Key Features

• Provides a simplified interface for easier interaction.
• Improves documentation with enhanced help messages. ~- Supports multiple system languages (English, German, Spanish).~ todo
• JSON output.
• HTML output.
• Markdown output.
• bash menu output
• whiptail/dialog output

Future Enhancements

• Implementation of man pages generation.

Testing

Extensive testing will be conducted to ensure accurate and complete documentation generation, as well as fine-tuning of output formats for optimal readability.

Additional Information

The primary focus of this implementation is to enhance the accessibility and comprehensibility of the Armbian Build Framework through robust documentation.

[adeepn]

You are doing something strange with localization)

https://mywiki.wooledge.org/BashFAQ/098

[Tearran]

You are doing something strange with localization)

https://mywiki.wooledge.org/BashFAQ/098

@adeepn It seems like you found something interesting with localization! I appreciate the link to the BashFAQ, and running LANGUAGE=es_ES ./armbian-build.sh was quite insightful.

I want to mention that the language selection in my script was primarily a placeholder for addressing locales. The main focus was on formatting the English output into JSON, key pairs, and dialog boxes. A loop for gettext could potentially be set up to improve localization.

It's a work in progress, and I'm open to any suggestions or improvements.

Thanks for your input!

[Tearran]

Quick Video showing the outputs

https://youtu.be/W1GXxkw-0zs

Example of the html output

https://codepen.io/Tearran/pen/ZEwKaXe

Quick use

{
wget https://raw.githubusercontent.com/Tearran/build/DOC-1/armbian-build ; 
bash ./armbian-build -h ;
}

[Tearran]

Will output features.md and featuesr.sh for example

Hidden_options

Feature	desc	example	src_reference	status
ARMBIAN_MIRROR	Overrides automated mirror selection	null	references	active
AUFS	Include support for AUFS	null	references	active

[Tearran]

Quick conversions of https://github.com/armbian/build/pull/6389/files

This is a great array. as

Tried to make PR update, maybe idea is enough to talk.