Mass edit README.md: remove top award/author lines
As requested on GitHub: a tool that will be written, readme2index, will,
as explained:
'... will take the converted HTML from the README.md markdown and
inject it into an HTML template. Things such title, award one and
author information will be injected into the HTML page ahead of the
HTML that was converted from the README.md markdown. Without going
into details of HOW at this time, the result will be a coherent HTML
index.html page with the winner title / award, winning author
information, and important file links come from other sources and
NOT from the README.md file.
The text from the 1st award line, thru the authorship information,
and up to but not including the "## To build:" line in the README.md
file will just get in the way. Moreover authors might be tempted to
try and maintain that top of README.md text instead of working with
the author/_author_handle_.json and winner .winner.json files.
This was done with my[0] sgit(1) (https://github.com/xexyl/sgit) tool like:
sgit -o -n -e '/^## To build:/,$p' '[12][0-9][0-9][0-9]/*/README.md'
[0] Is that shameless self-promotion? I don't know but I don't care: it
is generally a very useful tool and has been used in other repos too.
Besides, I've done it many times before and it's a great example that I
will be adding to the README.md file of the tool, one I hadn't thought
of doing.
This commit is contained in:
1 parent
f209de672f
commit
249e865de2
317 files changed
-2302
No files matched your search
@@ -1,11 +1,3 @@
|
||||
# Best abuse of the rules
|
||||
|
||||
Diomidis Spinellis\
|
||||
GR\
|
||||
<https://www.spinellis.gr/>\
|
||||
Mastodon: <https://mstdn.social/@DSpinellis>
|
||||
|
||||
|
||||
## To build:
|
||||
|
||||
```sh
|
||||
|
||||
Reference in new issue
Block a user