Open LecrisUT opened 1 year ago
I'd say that the README
content is quite clear about what the repository is about and don't find much benefit in renaming it. Also it already is kind of a template, as you can take it and just substitute the example content with your functions and documentation. I find this way more user friendly than creating artificial templates with many empty sections which need to have attached documentation to understand where to put what.
Github templates allow to basically fork out of it. I don't know if it supports any substitution, but it advertises in a sense where others can find such reusable plans. I find it a bit confusing though as to what is beakerlib
/tmt
specific, and what is simply description of the repo. E.g. do I need to follow the same readme structure, what are the files that describe the library?
Ok, I see, don't have any experience with the GitHub templates but that sounds quite useful. The only required files for the template would be lib.sh
and main.fmf
with the metadata (and of course .fmf
directory marking the tree root).
E.g. do I need to follow the same readme structure, what are the files that describe the library?
Understood. Actually the README
content is to be generated from the lib.sh
file so that you can maintain the code and related documentation at one place. Seems it would be good to document this better as well.
At first glance this would look like an example of a beakerlib test, not of a library. Some suggestions to make it clearer:
README.md
reflect how to design/install the library, rather then what the example library does. The latter could be moved or included as a foldable/code_block section