From 7352698d27f434575d89373f16df97f819f6216c Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Mon, 13 Nov 2023 04:23:03 -0800 Subject: [PATCH] Improve the way the FAQ table of contents looks --- faq.md | 74 +++++++++++++++++++++++++++------------------------------- 1 file changed, 35 insertions(+), 39 deletions(-) diff --git a/faq.md b/faq.md index e8b7aa2a3..6486a7139 100644 --- a/faq.md +++ b/faq.md @@ -1,57 +1,53 @@ # FAQ Table of Contents ## Section 0 - [History of the IOCCC](#faq0) -- [0.0 - How did the IOCCC get started?](#faq0_0) -- [0.1 - Why are some years missing IOCCC winners?](#faq0_1) -- [0.2 - Why do some IOCCC winners receive the Grand Prize or Best of Show award?](#faq0_2) +- [0.0 - How did the IOCCC get started?](#faq0_0) +- [0.1 - Why are some years missing IOCCC winners?](#faq0_1) +- [0.2 - Why do some IOCCC winners receive the Grand Prize or Best of Show award?](#faq0_2) ## Section 1 - [Submitting entries to a new IOCCC](#faq1) -- [1.0 - What types of entries have been over-submitted to the IOCCC?](#faq1_0) -- [1.1 - What should I put in my entry's Makefile?](#faq1_1) -- [1.2 - May I use a different source or compiled filename than prog.c or prog?](#faq1_2) -- [1.3 - What platform should I assume for my entry?](#faq1_3) +- [1.0 - What types of entries have been over-submitted to the IOCCC?](#faq1_0) +- [1.1 - What should I put in my entry's Makefile?](#faq1_1) +- [1.2 - May I use a different source or compiled filename than prog.c or prog?](#faq1_2) +- [1.3 - What platform should I assume for my entry?](#faq1_3) ## Section 2 - [IOCCC Judging process](#faq2) -### FAQ 2.0 - [How many entries do the judges receive for a given IOCCC?](#faq2_0) -### FAQ 2.1 - [What should I put in the remarks.md file of my entry?](#faq2_1) -### FAQ 2.2 - [Why don't you publish non-winners?](#faq2_2) -### FAQ 2.3 - [How much time does it take to judge the contest?](#faq2_3) -### FAQ 2.4 - [How many judging rounds do you have?](#faq2_4) +- [2.0 - How many entries do the judges receive for a given IOCCC?](#faq2_0) +- [2.1 - What should I put in the remarks.md file of my entry?](#faq2_1) +- [2.2 - Why don't you publish non-winners?](#faq2_2) +- [2.3 - How much time does it take to judge the contest?](#faq2_3) +- [2.4 - How many judging rounds do you have?](#faq2_4) ## Section 3 - [Compiling and running IOCCC winners](#faq3) - -### FAQ 3.0 - [What Makefile are available to build or clean up IOCCC winners?](#faq3_0) -### FAQ 3.1 - [Why doesn't this IOCCC winner compile?](#faq3_1) -### FAQ 3.2 - [Why does a IOCCC winner fail on my 64-bit system?](#faq3_2) -### FAQ 3.3 - [Why do some IOCCC winners fail to compile under macOS?](#faq3_3) -### FAQ 3.4 - [Why does clang or gcc fail to compile an IOCCC winner?](#faq3_4) -### FAQ 3.5 - [What is this cb tool that is mentioned in the IOCCC?](#faq3_5) -### FAQ 3.6 - [An IOCCC winner missed by my terminal application, how do I fix this?](#faq3_6) -### FAQ 3.7 - [How do I compile and use on macOS, an IOCCC winner that requires X11?](#faq3_7) -### FAQ 3.8 - [How do I compile an IOCCC winner that requires SDL1 or SDL2?](#faq3_8) -### FAQ 3.9 - [How do I compile and use on macOS, an IOCCC winner that requires sound?](#faq3_9) -### FAQ 3.10 - [Why do Makefiles use -Weverything with clang?](#faq3_10) +- [3.0 - What Makefile are available to build or clean up IOCCC winners?](#faq3_0) +- [3.1 - Why doesn't this IOCCC winner compile?](#faq3_1) +- [3.2 - Why does a IOCCC winner fail on my 64-bit system?](#faq3_2) +- [3.3 - Why do some IOCCC winners fail to compile under macOS?](#faq3_3) +- [3.4 - Why does clang or gcc fail to compile an IOCCC winner?](#faq3_4) +- [3.5 - What is this cb tool that is mentioned in the IOCCC?](#faq3_5) +- [3.6 - An IOCCC winner missed by my terminal application, how do I fix this?](#faq3_6) +- [3.7 - How do I compile and use on macOS, an IOCCC winner that requires X11?](#faq3_7) +- [3.8 - How do I compile an IOCCC winner that requires SDL1 or SDL2?](#faq3_8) +- [3.9 - How do I compile and use on macOS, an IOCCC winner that requires sound?](#faq3_9) +- [3.10 - Why do Makefiles use -Weverything with clang?](#faq3_10) ## Section 4 - [Changes made to IOCCC winners](#faq4) - -### FAQ 4.0 - [Why are some winning author remarks incongruent with the winning IOCCC code?](#faq4_0) -### FAQ 4.1 - [Why were some calls to the libc function gets changed to use fgets?](#faq4_1) -### FAQ 4.2 - [What was changed in an IOCCC winner source code?](#faq4_2) -### FAQ 4.3 - [Why do author remarks sometimes not match the source?](#faq4_3) -### FAQ 4.4 - [What is the meaning of the file ending in .orig.c in IOCCC winners?](#faq4_4) +- [4.0 - Why are some winning author remarks incongruent with the winning IOCCC code?](#faq4_0) +- [4.1 - Why were some calls to the libc function gets changed to use fgets?](#faq4_1) +- [4.2 - What was changed in an IOCCC winner source code?](#faq4_2) +- [4.3 - Why do author remarks sometimes not match the source?](#faq4_3) +- [4.4 - What is the meaning of the file ending in .orig.c in IOCCC winners?](#faq4_4) ## Section 5 - [Updating or correcting IOCCC web site content](#faq5) - -### FAQ 5.0 - [Why does an IOCCC winner fail to compile or or fail run?](#faq5_0) -### FAQ 5.1 - [How do I report a bug in an IOCCC winner?](#faq5_1) +- [5.0 - Why does an IOCCC winner fail to compile or or fail run?](#faq5_0) +- [5.1 - How do I report a bug in an IOCCC winner?](#faq5_1) ## Section 6 - [Miscellaneous IOCCC](#faq6) - -### FAQ 6.0 - [How did an entry breaks the size rule 2, win the IOCCC?](#faq6_0) -### FAQ 6.1 - [Is there a list of known bugs and misfeatures of IOCCC winners?](#faq6_1) -### FAQ 6.2 - [May I mirror the IOCCC web site?](#faq6_2) -### FAQ 6.3 - [May I use parts of the IOCCC in an article, book, newsletter, or instructional material?](#faq6_3) -### FAQ 6.4 - [Why do you sometimes use the first person plural?](#faq6_4) +- [6.0 - How did an entry breaks the size rule 2, win the IOCCC?](#faq6_0) +- [6.1 - Is there a list of known bugs and (mis)features of IOCCC winners?](#faq6_1) +- [6.2 - May I mirror the IOCCC web site?](#faq6_2) +- [6.3 - May I use parts of the IOCCC in an article, book, newsletter, or instructional material?](#faq6_3) +- [6.4 - Why do you sometimes use the first person plural?](#faq6_4) # The IOCCC FAQ