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

+15 -10
View File
@@ -13,8 +13,9 @@ The primary site can be found at [www.ioccc.org](https://www.ioccc.org).
Use `make` to compile entries. It is possible that on non-Unix / non-Linux
systems the Makefile needs to be changed. See the Makefile for details.
Read over the Makefile for compile/build issues. Your system may require
certain changes (add or remove a library, add or remove a #define).
Read over the Makefile and index.html files for compile/build issues. Your
system may require certain changes (add or remove a library, add or remove a
`#define`).
Some C compilers are not quite as good as they should be. If yours is
lacking, you may need to compile using clang or gcc instead of your local
@@ -25,9 +26,11 @@ compiler.
This year's winning entries are impressive!
The "Most in need of debugging" (endoh) is very inventive in a way it produces its own text!
The ["Most in need of debugging" (endoh)](endoh/index.html) is very inventive in
a way it produces its own text!
The "Most likely to be awarded" (ciura) has an amazing vocabulary!
The ["Most likely to be awarded" (ciura)](ciura/index.html) has an amazing
vocabulary!
There are again nods to entries of the years:
@@ -36,12 +39,14 @@ There are again nods to entries of the years:
These nods to not run afoul of the guideline:
We tend to dislike programs that:
...
are rather similar to previous entries
```
We tend to dislike programs that:
...
are rather similar to previous entries
```
because the entry [2019/dogon](2019/dogon/index.html) appropriately pays homage to past entries
without blatantly reusing their code.
because the entry [2019/dogon](2019/dogon/index.html) appropriately pays homage
to past entries without blatantly reusing their code.
...We'll stop spouting spoilers now. Have fun exploring all the entries!
@@ -56,7 +61,7 @@ uninitialized locals and/or reading-writing below the stack.
We advise running your entry through valgrind to make sure those mistakes
are avoided.
Using extra arguments to main, or arguments of wrong types as a quick and dirty
Using extra arguments to `main`, or arguments of wrong types as a quick and dirty
way of declaring variables is now passé. Clang, for example, rejects them outright.
We hope the authors of some of those entries will fix and re-submit