Code health badges used to be copy-pasted into the README.adoc. They spanned over several hundreds lines of code, and this approach was inconvenient and error-prone in general.
ERB to the rescue! The README.adoc.erb is now processed in GHA, then pushed back to the repository as .github/README.adoc. GitHub understands that this file should be displayed on repository main page, and project root is not polluted. The old one README.adoc is no longer tracked by Git.
Also, a Makefile has been added, which controls README processing. In development, make all can be used to produce a README.html.
Code health badges used to be copy-pasted into the
README.adoc
. They spanned over several hundreds lines of code, and this approach was inconvenient and error-prone in general.ERB to the rescue! The
README.adoc.erb
is now processed in GHA, then pushed back to the repository as.github/README.adoc
. GitHub understands that this file should be displayed on repository main page, and project root is not polluted. The old oneREADME.adoc
is no longer tracked by Git.Also, a
Makefile
has been added, which controls README processing. In development,make all
can be used to produce aREADME.html
.Fixes #7