From 0bcda80b2899deb6e87141da58dcb25f95b1ebd5 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Mon, 26 Aug 2024 09:39:25 -0700 Subject: [PATCH] Make thanks file MUCH MORE humble and improve FAQ Something that has bothered me VERY MUCH for A VERY LONG TIME is that the honour roll (under my name) was not very humble and in some respects rather redundant. I have fixed this a great deal and improved the readability of it too (grammar and so on). I also added a point about fixing many entries that no longer worked and I also did this for Yusuke Endoh too as he was responsible for fixing numerous (at the least) entries that no longer worked (and it should be acknowledged and honoured just as much as what I did). The FAQ I improved is related to one of the things that is in the above, to do with alternate code. It now explains some of the purposes of alternate code and why (in some cases) alt code was added when it might or might not be useful (a judgement call that invariably is not always perfect). It notes that in many cases the alternate code comes from the author directly. With these changes a problem that I felt was a VERY BIG problem should be resolved now. --- faq.html | 29 ++++++++++++++++-------- faq.md | 31 ++++++++++++++++++-------- thanks-for-help.html | 53 ++++++++++++++++++++++---------------------- thanks-for-help.md | 53 ++++++++++++++++++++++---------------------- 4 files changed, 96 insertions(+), 70 deletions(-) diff --git a/faq.html b/faq.html index 1371ee2a8..785b7e70a 100644 --- a/faq.html +++ b/faq.html @@ -461,7 +461,7 @@
This was a judgement call and the reasons vary. In many cases it was simply to -make the entry more presentable to more people but without modifying the entry -itself, which would be tampering with the entry, and in some cases it would be -changing it so much that it would no longer be what was submitted.
+The alternate versions are exactly what they sound like, versions of their +respective entries that were not the winning source code but have additional +features added (often by the author) or fixes, updates at the request of the +judges (upon winning the contest), unobfuscated versions and a variety of other +things for instance letting it work on more than one platform (where it would +not be possible to do in the original submission).
+In some cases the alternate code added come directly from the author (some of +which already were in the website) but there were other cases where alternate +code was added that might or might not be necessary; this was a judgement call +and the reasons vary.
+In many cases it was simply to make the entry more presentable to more people +but without modifying the entry itself, which would be tampering with the entry +(a problem that we tried to avoid as much as possible although we certainly did +not manage to do this perfectly), and in some cases it would be changing it so +much that it would no longer be what was submitted.
In one case an alternate version was created to help locate and fix a bug that prevented the entry from working properly and it seemed like it should be added -as well, for fun.
-In some cases it might be better to not have them but as noted this is a +as well, for fun (it is a game).
+In some cases it might be better to not have them but as noted this was a judgement call.
-See the +
See also the FAQ on “original source code” for more information.
Jump to: top
diff --git a/faq.md b/faq.md index 674291323..7fd1dc792 100644 --- a/faq.md +++ b/faq.md @@ -73,7 +73,7 @@ This is FAQ version **28.0.4 2024-08-24**. - 4.3 - Why do author remarks sometimes not match the source and/or why are there other inconsistencies with the original entry? - 4.4 - What is the meaning of the file ending in .orig.c in IOCCC entries? -- 4.5 - Why were alternate versions added to some entries when the original entry worked fine and well? +- 4.5 - What are alternate versions and why were alternate versions added to some entries when the original entry worked fine and well? - 4.6 - Why was arg count and/or type changed in main() in some older entries? - 4.7 - Why were some filenames changed? - 4.8 - Why were files added or removed from some entries? @@ -4021,24 +4021,37 @@ Jump to: [top](#)Just for awareness, here: Cody made some corrections to the vital Double
+ Just for awareness: Cody made some corrections to the vital Double
layered chocolate fudge cake recipe :-)
Other fixes were made but as it’s his entry it’s not worth noting. We call out the extensive contributions of Cody Boone
Ferguson who is responsible for most of the
-improvements and fixes including many EXTREMELY HARD bug fixes (for certain
-definitions of HARD :-) ) like
+improvements and fixes including fixing many entries that no longer worked
+(and other important bug fixes), often EXTREMELY HARD (for certain
+definitions of ‘HARD’ :-) ), like
1988/phillipps,
1992/vern,
2001/anonymous,
2004/burley and
-2005/giljade, making all entries such as
+2005/giljade; making all entries, such as
1985/sicherman and
-1986/wall not need He also wrote sgit to easily run
--traditional-cpp (all
-EXTREMELY HARD), fixing entries to work with clang, some EXTREMELY
-HARD like 1991/dds, or as much as possible
-(1989/westley, a true masterpiece that is
-INCREDIBLY HARD, MUCH MORE SO than any other fix!), porting entries to
-macOS (some EXTREMELY HARD like
-1998/schweikh1, fixing code like
-2001/herrmann2 to work in both
-32-bit/64-bit which can be EXTREMELY HARD, providing alternate code where
-useful/necessary, improving ALL Makefiles and writing scripts to greatly
-simplify running many of the entries.sed(1) on files in the repo which we used to help build the website.-traditional-cpp, to no longer require it; fixing
+entries like 1991/dds (or, as in the case of
+1989/westley, a true masterpiece in
+obfuscation, as much as possible) to work with clang; porting entries such as
+1998/schweikh1 to macOS; fixing code like
+2001/herrmann2 to work in both 32-bit and
+64-bit; providing alternate code where useful/necessary;
+improving all Makefiles; and writing scripts to greatly simplify running many
+of the entries.
Cody also wrote the feature-rich sgit to easily
+run sed(1) on files in the repo which we used to help build the website.
Cody Boone Ferguson also used one of his own tools to detect many dead links. While the tool was not perfect it went a long way to uncover a good number of -bad, broken or otherwise invalid links. It was a very laborious task to copy -and paste problematic links into the Internet Wayback +bad, broken or otherwise invalid links. It was a very laborious task to copy and +paste problematic links into the Internet Wayback Machine in an effort to try and find otherwise lost content. A good number of links that now refer to something in the Internet Wayback Machine replace bad, broken, or otherwise invalid links are thanks to Cody’s efforts! Another tool he wrote detected -inconsistent award titles in the README files and CSV file (that he generated -from the SQL file).
+inconsistent award titles in theREADME.md files (used to generate the
+index.html files) and the CSV file that he generated from our SQL file.
Additionally Cody greatly improved the manifest of the winning entries and -checked that the generated html files, index.html and otherwise, look well and -presentable and suggested some CSS rules for image responsiveness on smaller -screens and other improvements.
+checked that the generated html files,index.html and otherwise, look well and
+are presentable, and he also suggested some CSS rules for image responsiveness on smaller
+screens, as well as some other improvements.
THANK YOU VERY MUCH for your extensive efforts in helping improve the IOCCC presentation of past IOCCC entries and fixing almost all past entries for modern systems!
@@ -4828,8 +4828,9 @@ systems!Yusuke Endoh supplied a -number of important bug fixes to a number of past IOCCC entries. Some of those -fixes were EXTREMELY TECHNICALLY CHALLENGING such as +number of important bug fixes to a number of past IOCCC entries, including +fixing numerous entries that no longer worked. Some of those +fixes were EXTREMELY TECHNICALLY CHALLENGING, such as 1989/robison, 1990/cmills, 1992/lush and diff --git a/thanks-for-help.md b/thanks-for-help.md index 1982f0863..a0578a33c 100644 --- a/thanks-for-help.md +++ b/thanks-for-help.md @@ -5984,7 +5984,7 @@ alternate code provided by the author, Yusuke. ### Winning entry source code: [prog.c](%%REPO_URL%%/2020/ferguson1//prog.c) -Just for awareness, here: [Cody](#cody) made some corrections to the vital [Double +Just for awareness: [Cody](#cody) made some corrections to the vital [Double layered chocolate fudge cake recipe](2020/ferguson1/chocolate-cake.html) :-) Other fixes were made but as it's his entry it's not worth noting. @@ -6230,44 +6230,44 @@ helped improve the presentation of their fellow IOCCC entries. We call out the extensive contributions of [Cody Boone Ferguson](authors.html#Cody_Boone_Ferguson) who is responsible for most of the -improvements and fixes including many **EXTREMELY HARD bug fixes** (for certain -definitions of **_HARD_** :-) ) like +improvements and fixes including **fixing _many entries_ that no longer worked** +(and other important bug fixes), often **EXTREMELY HARD** (for certain +definitions of '_HARD_' :-) ), like [1988/phillipps](thanks-for-help.html#1988_phillipps), [1992/vern](thanks-for-help.html#1992_vern), [2001/anonymous](thanks-for-help.html#2001_anonymous), [2004/burley](thanks-for-help.html#2004_burley) and -[2005/giljade](thanks-for-help.html#2005_giljade), making all entries such as +[2005/giljade](thanks-for-help.html#2005_giljade); making all entries, such as [1985/sicherman](thanks-for-help.html#1985_sicherman) and -[1986/wall](thanks-for-help.html#1986_wall) not need `-traditional-cpp` (all -**EXTREMELY HARD**), fixing entries to work with `clang`, some **EXTREMELY -HARD** like [1991/dds](thanks-for-help.html#1991_dds), or as much as possible -([1989/westley](thanks-for-help.html#1989_westley), a true masterpiece that is -**INCREDIBLY HARD, *MUCH MORE SO* than any other fix!**), porting entries to -macOS (some **EXTREMELY HARD** like -[1998/schweikh1](thanks-for-help.html#1998_schweikh1), fixing code like -[2001/herrmann2](thanks-for-help.html#2001_herrmann2) to work in both -32-bit/64-bit which *can be* **EXTREMELY HARD**, providing alternate code where -useful/necessary, improving **ALL _Makefiles_** and writing scripts to greatly -simplify running many of the entries. +[1986/wall](thanks-for-help.html#1986_wall), that +required `-traditional-cpp`, to no longer require it; fixing +entries like [1991/dds](thanks-for-help.html#1991_dds) (or, as in the case of +[1989/westley](thanks-for-help.html#1989_westley), a true masterpiece in +obfuscation, as much as possible) to work with `clang`; porting entries such as +[1998/schweikh1](thanks-for-help.html#1998_schweikh1) to macOS; fixing code like +[2001/herrmann2](thanks-for-help.html#2001_herrmann2) to work in both 32-bit and +64-bit; providing [alternate code](faq.html#alt_code) where useful/necessary; +improving all `Makefiles`; and writing scripts to greatly simplify running many +of the entries. -He also wrote [sgit](https://github.com/xexyl/sgit) to easily run -`sed(1)` on files in the repo which we used to help build the website. +Cody also wrote the feature-rich [sgit](https://github.com/xexyl/sgit) to easily +run `sed(1)` on files in the repo which we used to help build the website. Cody Boone Ferguson also used one of his own tools to detect many dead links. While the tool was not perfect it went a long way to uncover a good number of -bad, broken or otherwise invalid links. It was a very laborious task to copy -and paste problematic links into the [Internet Wayback +bad, broken or otherwise invalid links. It was a very laborious task to copy and +paste problematic links into the [Internet Wayback Machine](https://web.archive.org) in an effort to try and find otherwise lost content. A good number of links that now refer to something in the [Internet Wayback Machine](https://web.archive.org) replace bad, broken, or otherwise invalid links are thanks to Cody's efforts! Another tool he wrote detected -inconsistent award titles in the README files and CSV file (that he generated -from the SQL file). +inconsistent award titles in the `README.md` files (used to generate the +`index.html` files) and the CSV file that he generated from our SQL file. Additionally Cody greatly improved the manifest of the winning entries and -checked that the generated html files, index.html and otherwise, look well and -presentable and suggested some CSS rules for image responsiveness on smaller -screens and other improvements. +checked that the generated html files, `index.html` and otherwise, look well and +are presentable, and he also suggested some CSS rules for image responsiveness on smaller +screens, as well as some other improvements. **THANK YOU VERY MUCH** for your extensive efforts in helping improve the IOCCC presentation of past IOCCC entries and fixing almost all past entries for modern @@ -6279,8 +6279,9 @@ systems! [Yusuke Endoh](authors.html#Yusuke_Endoh) supplied a -number of important bug fixes to a number of past IOCCC entries. Some of those -fixes were **EXTREMELY TECHNICALLY CHALLENGING** such as +number of important bug fixes to a number of past IOCCC entries, including +**fixing _numerous entries_ that no longer worked**. Some of those +fixes were **EXTREMELY TECHNICALLY CHALLENGING**, such as [1989/robison](thanks-for-help.html#1989_robison), [1990/cmills](thanks-for-help.html#1990_cmills), [1992/lush](thanks-for-help.html#1992_lush) and