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

+1 -10
View File
@@ -1,5 +1,5 @@
# A todo list of known things to check and/or do
*Last updated: Thu 07 Mar 2024 16:59:49 UTC*
*Last updated: Thu 07 Mar 2024 18:16:13 UTC*
This document is for [Cody Boone Ferguson](/authors.html#Cody_Boone_Ferguson) as
he (that is I :-) ) wanted a way to keep track of things in a way that did not
@@ -15,15 +15,6 @@ something needs to be done is thought of it is also updated unless it can be
done right then and there or it seems more appropriate to add to the issue (#3)
todo list.
- Typo fix ALL markdown files. For the README.md files the entries have all been
done (along with format fixes) but the YYYY/README.md files have not been
completed.
* Go through all year README.md files: that is 1984/README.md,
1985/README.md and so on. As of **Mon 16 Oct 11:22:52 UTC 2023** the
following years have had a first pass: 1984 through 2001. However there are
changes that might be required in those years too so a pass over all of them
will have to be done at the time the files are to be reviewed.
- Check that the following todo tasks at:
<https://github.com/ioccc-src/temp-test-ioccc/issues/3#issuecomment-1583833132>
and