Format / typo check YYYY/README.md files

It should be pointed out that there are a few inconsistencies as noted
below.

In some years the title of entries that were explicitly listed were
linked to but as the README.md files no longer have the title it was not
as easy to locate the title (I could go back in archive/historic and I
did in some cases but I was trying to hurry this up to close #3).

It's most likely that some have backticks surrounding certain words like
gcc or something else but not in all files. An example that might be
there is '#define'.

Some wording is different. Usually this is due to the original wording
which I did not think was good to change. There might be other cases
that were missed as well. One thing is that comes to mind is that in
some README.md files it refers to the Makefile to check for build
instructions, in others it refers to the index.html file and in some it
refers to both. But the index.html has how to build so they should
probably all say index.html and not refer to the Makefile. This was also
done in a rush.

There might be other inconsistencies or things that might want to be
fixed but whether it's worth it given is unclear at this time. It can be
argued that the reference to the Makefiles for build instructions is a
historical comment to keep there as an example of why not to change it.

There were other things I noticed that I could not address or did not
feel were necessary but with this commit an important task is can likely
be considered done unless it is decided that some of these should be
fixed or if looking at the rendered output there is a problem.
This commit is contained in:
Cody Boone Ferguson committed 2024-03-07 10:27:49 -08:00
1 parent b49ea14615
commit e6040e083c
23 files changed
+162 -154

No files matched your search

+16 -15
View File
@@ -31,41 +31,42 @@ We believe you will be impressed with this year's winning entries.
In particular:
+ The [Abuse of the rules](klausler/klausler.c) used local dictionary data to
+ The [Abuse of the rules (klausler)](klausler/index.html) used local dictionary data to
get around the size limit.
+ The [Most beauteous visuals](vince/vince.c) made clever use of `{}`s and
+ The [Most beauteous visuals (vince)](vince/index.html) made clever use of `{}`s and
whitespace in their source code and during execution.
+ The [Most circuitous walk](vik/vik.c) entry is just amazing.
+ The [Most circuitous walk (vik)](vik/index.html) entry is just amazing.
+ The [Best game](toledo/toledo.c) makes full use of its single function.
+ The [Best game (toledo)](toledo/index.html) makes full use of its single function.
+ The [Best emulator](sykes) may allow you to reconnect to your first
+ The [Best emulator (sykes)](sykes/index.html) may allow you to reconnect to your first
[PET](https://en.wikipedia.org/wiki/Commodore_PET).
+ Our [Best of Show](persano/persano.c) this year was simply (or non-simply :-) ) the best!
+ Our [Best of Show (persano)](persano/index.html) this year was simply (or non-simply :-) ) the best!
+ (And we need only mention (parenthetically speaking) that the best use of parenthesis is self reproducing).
+ (And we need only mention (parenthetically speaking) that the [Best use of
parenthesis](mikeash/index.html) is self reproducing).
+ The [Most sonorous output](jetro/jetro.c) might `sound` :-) like a good idea.
+ The [Most sonorous output (jetro)](jetro/index.html) might `sound` :-) like a good idea.
+ The [Best 2D puzzle](giljade/giljade.c) takes editorial license with expressions as well as the
+ The [Best 2D puzzle (giljade)](giljade/index.html) takes editorial license with expressions as well as the
with the [vi editor](https://en.wikipedia.org/wiki/Vi).
+ The [Most ambiguous language](chia/chia.c) entry is really a C program.
+ The [Most ambiguous language (chia)](chia/index.html) entry is really a C program.
+ The [Most superfluous output](boutines/boutines.c) entry is simply
+ The [Most superfluous output (boutines)](boutines/index.html) entry is simply
[Voronoi](Voronoi)-lific!
+ Try not to have your sense of good coding offended by the [Most
discourteous interpreter](timwi/timwi.c) entry.
discourteous interpreter (timwi)](timwi/index.html) entry.
+ The [Best use of the www](mynx/mynx.c) doesn't include those letters.
+ The [Best use of the www (mynx)](mynx/index.html) doesn't include those letters.
+ You will be puzzled by the [Best 3D puzzle](anon/anon.c) entry; we are sure!
+ You will be puzzled by the [Best 3D puzzle (anon)](anon/index.html) entry; we are sure!
+ The [Most ingenious puzzle solution](aidan/aidan.c) might puzzle you more while it
+ The [Most ingenious puzzle solution (aidan)](aidan/index.html) might puzzle you more while it
puzzles out some puzzles: all in a puzzling way! :-)
### Remarks on some of the losing entries