Adjust quick install guide since we are making a repository on the fly

[igorpecovnik]

After verifying if we put it into wanted folders and if it works, automation builds upon changes.

[Tearran]

Overwrite changes

[igorpecovnik]

So we want to have README generated via Github actions?

[Tearran]

Automating the documentation is part of the project, since brand name issues or and compatibility remain concern within the community. Seemed prudent to use brand as naming convention. $filename --dev uses lib/$filename/* Use case Primarily for later error handling.

Where to direct the documentation, was unclear, so an option or Placeholder was made. Issue #20 cleared so that question

A test to Redirecting all generated to share/doc/$filename/ works locally can delete the whole folder and armbian-configng will make folder share/doc/armbian-config

Naming conventions

For example

ln -s armbian-configng armbian-configng-dev
cp -r  lib/armbian-configng lib/armbian-configng-dev
sudo armbian-configng-dev  -h

will try and use lib/armbian-configng-dev/* if it exist.

sudo armbian-configng-dev --doc will generate share/doc/armbian-configng-dev/*
currently will output path need adjusted from share/brand/documents to share/barand/doc/documents.
This will leave the main README statice.

Alternatively

unsupported-config would look for lib/Unsupported-config

[Tearran]

@igorpecovnik

So we want to have README generated via Github actions?

Not really, Was originally intended to have separate readme per Category. In a doc folder. This was the compromised that was made when it was agreed to direct focus away from building and understanding how a *.deb are built.

The doc generators can be easily directed to the share/doc folder now.

[igorpecovnik]

ok. merging this?

[Tearran]

Yes. Ran fine on a codespace.

Not sure, about the ci/cd. I only spent few days to get familiar with what a ci/cd pipeline is.

[igorpecovnik]

Not sure, about the ci/cd. I only spent few days to get familiar with what a ci/cd pipeline is.

CI complains about the SheelCheck inconsistency and that has to be taken into account. For future. I also need to add to skip non bash files.