From 571c24ee73c553b67b60e06983d5b09f110acedf Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Wed, 31 Jul 2024 09:01:31 -0700 Subject: [PATCH] Minor fixes/updates to FAQ Typo fixes, added a link name (for the other repo's FAQ) and maybe some other minor fixes/updates. --- faq.html | 17 +++++++++++------ faq.md | 18 ++++++++++++------ 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/faq.html b/faq.html index 24a53ad41..4927cd431 100644 --- a/faq.html +++ b/faq.html @@ -408,7 +408,7 @@
  • 0.13 - How can I validate my submission tarball?
  • 0.14 - What is the fnamchk tool?
  • 0.15 - What is the mkiocccentry tool and how do I use it?
    • -
  • 0.16 - How to I compile mkiocccentry and related tools?
    • +
  • 0.16 - How do I compile mkiocccentry and related tools?

    • Section 1 - History of the IOCCC

    -

    NOTE: Please see our IOCCC markdown guide for important information on using markdown in the IOCCC.

    -

    NOTE: It is NOT necessary to install the tools to use them as you can run -the tools from the top of the mkiocccentry repo directory just fine. However, +

    NOTE: Please see our IOCCC markdown guide for important information on using markdown in the IOCCC.

    +

    NOTE: It is NOT necessary to install the tools to use them as you can run +the tools from the top of the mkiocccentry repo directory just fine. However, installing it will make it easier for you as you can run it from your submission’s directory.

    If the mkiocccentry tool indicates that there is a problem with your entry, @@ -569,6 +569,7 @@ you are strongly encouraged to revise and correct your entry an then re-run the mkiocccentry tool.

    If you choose to risk violating rules, be sure an explain your reason for doing so in your remarks.md file.

    +

    See also Rule 17!

    6. Upload your entry to the IOCCC submit server

    The IOCCC submit server is still being written. As such, we do not yet have instructions @@ -577,13 +578,15 @@ on how upload your entry to the IOCCC submit server. Once with the proper instructions. Watch the IOCCC news for an announcement of the availability of the IOCCC submit server.

    +

    FAQ 0.1: What types of entries have been frequently submitted to the IOCCC?

    +

    There are types of entries that are frequently submitted to the IOCCC. While we do not wish to prevent people from sending a submission to the IOCCC on a frequently submitted theme, we do wish to provide a fair warning to those who do.

    -

    Fair warnings on frequently submitted themes

    +

    Fair warnings on frequently submitted themes:

    IMPORTANT HINT: It is not fatal to send in those types of entries, it is just HARDER to win with such a submission. A submission on a frequently submitted theme will have to do something @@ -706,8 +709,10 @@ your Makefile should copy prog.c into the desired file make compatible make(1) command that is compatible with GNU Make version 3.81.

    +

    FAQ 0.3: May I use a different source or compiled filename than prog.c or prog?

    +

    While your entry’s source filename, as submitted, must be prog.c, your entry’s Makefile may copy prog.c to a different filename as part of the compiling/building process. For example:

        all: desired_name
@@ -1808,7 +1813,7 @@ or more of these tools manually.
    
 (and in particular Rule 17).
    
 
    
 
    
-
    FAQ 0.16 - How to I compile mkiocccentry and its related tools?
    
+
    FAQ 0.16 - How do I compile mkiocccentry and its related tools?
    
 
    
 
    
 
    After you
diff --git a/faq.md b/faq.md
index 49f5f7bc5..129c42c7f 100644
--- a/faq.md
+++ b/faq.md
@@ -20,7 +20,7 @@ This is FAQ version **28.0.3 2024-07-27**.
 - 0.13 - How can I validate my submission tarball?
 - 0.14 - What is the `fnamchk` tool?
 - 0.15 - What is the `mkiocccentry` tool and how do I use it?
-- 0.16 - How to I compile `mkiocccentry` and related tools?
+- 0.16 - How do I compile `mkiocccentry` and related tools?
 
 
 ## Section  1 - [History of the IOCCC](#faq1)
@@ -217,10 +217,10 @@ where:
 
     Optional extra data files to include with your entry
 
-NOTE: Please see our [IOCCC markdown guide](markdown.html) for **important information** on using markdown in the IOCCC.
+**NOTE**: Please see our [IOCCC markdown guide](markdown.html) for **important information** on using markdown in the IOCCC.
 
-NOTE: It is *NOT* necessary to install the tools to use them as you can run
-the tools from the top of the _mkiocccentry repo_ directory just fine. However,
+**NOTE**: It is *NOT* necessary to install the tools to use them as you can run
+the tools from the top of the `mkiocccentry` repo directory just fine. However,
 installing it will make it easier for you as you can run it from your
 submission's directory.
 
@@ -232,6 +232,8 @@ then re-run the `mkiocccentry` tool.
 If you choose to risk violating rules, be sure an explain your reason
 for doing so in your `remarks.md` file.
 
+See also [Rule 17](next/rules.html#rule17)!
+
 
 #### 6. Upload your entry to the IOCCC submit server
 
@@ -245,8 +247,10 @@ for an announcement of the availability of the **IOCCC submit server**.
 
 
 
    
+
    
 ### FAQ 0.1: What types of entries have been frequently submitted to the IOCCC?
 
    
+
    
 
 There are types of entries that are frequently submitted to the IOCCC.
 While we **do not wish to prevent** people from sending
@@ -254,7 +258,7 @@ a submission to the IOCCC on a frequently submitted theme,
 we do wish to provide a **fair warning** to those who do.
 
 
-#### Fair warnings on frequently submitted themes
+#### Fair warnings on frequently submitted themes:
 
 **IMPORTANT HINT**: It is **not fatal** to send in those types of
 entries, it is just **HARDER to win** with such a submission.  A
@@ -411,8 +415,10 @@ command that is compatible with GNU Make version 3.81.
 
 
 
    
+
    
 ### FAQ 0.3: May I use a different source or compiled filename than prog.c or prog?
 
    
+
    
 
 While your entry's source filename, as submitted, must be `prog.c`, your entry's `Makefile`
 may copy `prog.c` to a different filename as part of the compiling/building process.  For example:
@@ -1638,7 +1644,7 @@ See also the [Guidelines](next/guidelines.html) and the [Rules](next/rules.html)
 
 
    
 
    
-### FAQ 0.16 - How to I compile `mkiocccentry` and its related tools?
+### FAQ 0.16 - How do I compile `mkiocccentry` and its related tools?