firmware icon indicating copy to clipboard operation
firmware copied to clipboard

RFC: modify buildsystem docs in README.md

Open akira25 opened this issue 5 years ago • 5 comments

This is meant to be an first improvement for the issues in documentation addressed in #824. This commit mainly takes some of documentation of weimarnetz and adds that to our README.md

akira25 avatar Jun 28 '20 18:06 akira25

Improved docs are always welcome.

Before putting much work into this, we should discuss on https://github.com/freifunk-berlin/firmware/pull/765 as it will change many of the existing folders.

SvenRoederer avatar Jun 28 '20 20:06 SvenRoederer

Improved docs are always welcome.

Before putting much work into this, we should discuss on #765 as it will change many of the existing folders.

I'm already finished. I'd prefer to have this merged fairly soon, as anyone how like to use our buildsystem now, would need to invest much debugging effort into it, until he gets to know, where to configure anything.

akira25 avatar Jul 03 '20 12:07 akira25

Besides that, regarding our current development velocity, I don't think we will have a decision on #765 within the next 1.5 Years.

akira25 avatar Jul 03 '20 12:07 akira25

@SvenRoederer There were 37 (±2) requests for changes in total. Please feel free to include them into the README-File. It might be faster to do it by yourself, then writing me, what I should change. I will no longer invest effort into this. You seem to be the only one, who knows how this buildsystem works.

Sadly, the documentation will still document a different state than the current one.

akira25 avatar Oct 10 '20 16:10 akira25

@SvenRoederer There were 37 (±2) requests for changes in total. Please feel free to include them into the README-File. It might be faster to do it by yourself, then writing me, what I should change.

That's the downside of having the PR source from your private Repo-fork ... Only you have permission to commit to it. My impression was, that the most of the open changes were were most "consistency of terms" and generic comments.

I will no longer invest effort into this. You seem to be the only one, who knows how this buildsystem works.

I got used to it and found some smart ideas inside. Sadly I seems to be the only one still working on it, as the "old" developers (@sarumpaet @booo @andrenarchy @lynxis ) seem to have retired.

Sadly, the documentation will still document a different state than the current one.

Indeed your updated documentation somehow based on the outdated system before switching to "modules"-file.

But thanks for your work so far. I'll reopen, in case someone else likes to continue here.

SvenRoederer avatar Oct 20 '20 00:10 SvenRoederer