Minor fixes/updates to FAQ

Typo fixes, added a link name (for the other repo's FAQ) and maybe some
other minor fixes/updates.
This commit is contained in:
Cody Boone Ferguson committed 2024-07-31 09:01:31 -07:00
1 parent f6b15761b8
commit 571c24ee73
2 files changed
+23 -12

No files matched your search

+11 -6
View File
@@ -408,7 +408,7 @@
<li><a class="normal" href="#faq0_13">0.13 - How can I validate my submission tarball?</a></li> <li><a class="normal" href="#faq0_13">0.13 - How can I validate my submission tarball?</a></li>
<li><a class="normal" href="#faq0_14">0.14 - What is the <code>fnamchk</code> tool?</a></li> <li><a class="normal" href="#faq0_14">0.14 - What is the <code>fnamchk</code> tool?</a></li>
<li><a class="normal" href="#faq0_15">0.15 - What is the <code>mkiocccentry</code> tool and how do I use it?</a></li> <li><a class="normal" href="#faq0_15">0.15 - What is the <code>mkiocccentry</code> tool and how do I use it?</a></li>
<li><a class="normal" href="#faq0_16">0.16 - How to I compile <code>mkiocccentry</code> and related tools?</a></li> <li><a class="normal" href="#faq0_16">0.16 - How do I compile <code>mkiocccentry</code> and related tools?</a></li>
</ul> </ul>
<h2 id="section-1---history-of-the-ioccc">Section 1 - <a href="#faq1">History of the IOCCC</a></h2> <h2 id="section-1---history-of-the-ioccc">Section 1 - <a href="#faq1">History of the IOCCC</a></h2>
<ul> <ul>
@@ -558,9 +558,9 @@ for more info.</p></li>
<li><p>[file …]</p> <li><p>[file …]</p>
<p>Optional extra data files to include with your entry</p></li> <p>Optional extra data files to include with your entry</p></li>
</ul> </ul>
<p>NOTE: Please see our <a href="markdown.html">IOCCC markdown guide</a> for <strong>important information</strong> on using markdown in the IOCCC.</p> <p><strong>NOTE</strong>: Please see our <a href="markdown.html">IOCCC markdown guide</a> for <strong>important information</strong> on using markdown in the IOCCC.</p>
<p>NOTE: It is <em>NOT</em> necessary to install the tools to use them as you can run <p><strong>NOTE</strong>: It is <em>NOT</em> necessary to install the tools to use them as you can run
the tools from the top of the <em>mkiocccentry repo</em> directory just fine. However, the tools from the top of the <code>mkiocccentry</code> repo directory just fine. However,
installing it will make it easier for you as you can run it from your installing it will make it easier for you as you can run it from your
submission’s directory.</p> submission’s directory.</p>
<p>If the <code>mkiocccentry</code> tool indicates that there is a problem with your entry, <p>If the <code>mkiocccentry</code> tool indicates that there is a problem with your entry,
@@ -569,6 +569,7 @@ you are <strong>strongly</strong> encouraged to revise and correct your entry an
then re-run the <code>mkiocccentry</code> tool.</p> then re-run the <code>mkiocccentry</code> tool.</p>
<p>If you choose to risk violating rules, be sure an explain your reason <p>If you choose to risk violating rules, be sure an explain your reason
for doing so in your <code>remarks.md</code> file.</p> for doing so in your <code>remarks.md</code> file.</p>
<p>See also <a href="next/rules.html#rule17">Rule 17</a>!</p>
<h4 id="upload-your-entry-to-the-ioccc-submit-server">6. Upload your entry to the IOCCC submit server</h4> <h4 id="upload-your-entry-to-the-ioccc-submit-server">6. Upload your entry to the IOCCC submit server</h4>
<p>The <strong>IOCCC submit server</strong> is still being written. <p>The <strong>IOCCC submit server</strong> is still being written.
<!--XXX--> As such, we do not yet have instructions <!--XXX--> As such, we do not yet have instructions
@@ -577,13 +578,15 @@ on how upload your entry to the <strong>IOCCC submit server</strong>. Once
with the proper instructions. Watch the <a href="news.html">IOCCC news</a> with the proper instructions. Watch the <a href="news.html">IOCCC news</a>
for an announcement of the availability of the <strong>IOCCC submit server</strong>.</p> for an announcement of the availability of the <strong>IOCCC submit server</strong>.</p>
<div id="faq0_1"> <div id="faq0_1">
<div id="frequent-themes">
<h3 id="faq-0.1-what-types-of-entries-have-been-frequently-submitted-to-the-ioccc">FAQ 0.1: What types of entries have been frequently submitted to the IOCCC?</h3> <h3 id="faq-0.1-what-types-of-entries-have-been-frequently-submitted-to-the-ioccc">FAQ 0.1: What types of entries have been frequently submitted to the IOCCC?</h3>
</div> </div>
</div>
<p>There are types of entries that are frequently submitted to the IOCCC. <p>There are types of entries that are frequently submitted to the IOCCC.
While we <strong>do not wish to prevent</strong> people from sending While we <strong>do not wish to prevent</strong> people from sending
a submission to the IOCCC on a frequently submitted theme, a submission to the IOCCC on a frequently submitted theme,
we do wish to provide a <strong>fair warning</strong> to those who do.</p> we do wish to provide a <strong>fair warning</strong> to those who do.</p>
<h4 id="fair-warnings-on-frequently-submitted-themes">Fair warnings on frequently submitted themes</h4> <h4 id="fair-warnings-on-frequently-submitted-themes">Fair warnings on frequently submitted themes:</h4>
<p><strong>IMPORTANT HINT</strong>: It is <strong>not fatal</strong> to send in those types of <p><strong>IMPORTANT HINT</strong>: It is <strong>not fatal</strong> to send in those types of
entries, it is just <strong>HARDER to win</strong> with such a submission. A entries, it is just <strong>HARDER to win</strong> with such a submission. A
submission on a frequently submitted theme will have to do something submission on a frequently submitted theme will have to do something
@@ -706,8 +709,10 @@ your <code>Makefile</code> should copy <code>prog.c</code> into the desired file
make compatible</a> <code>make(1)</code> make compatible</a> <code>make(1)</code>
command that is compatible with GNU Make version 3.81.</p> command that is compatible with GNU Make version 3.81.</p>
<div id="faq0_3"> <div id="faq0_3">
<div id="prog">
<h3 id="faq-0.3-may-i-use-a-different-source-or-compiled-filename-than-prog.c-or-prog">FAQ 0.3: May I use a different source or compiled filename than prog.c or prog?</h3> <h3 id="faq-0.3-may-i-use-a-different-source-or-compiled-filename-than-prog.c-or-prog">FAQ 0.3: May I use a different source or compiled filename than prog.c or prog?</h3>
</div> </div>
</div>
<p>While your entry’s source filename, as submitted, must be <code>prog.c</code>, your entry’s <code>Makefile</code> <p>While your entry’s source filename, as submitted, must be <code>prog.c</code>, your entry’s <code>Makefile</code>
may copy <code>prog.c</code> to a different filename as part of the compiling/building process. For example:</p> may copy <code>prog.c</code> to a different filename as part of the compiling/building process. For example:</p>
<pre><code> all: desired_name <pre><code> all: desired_name
@@ -1808,7 +1813,7 @@ or more of these tools manually.</p>
(and in particular <a href="next/rules.html#rule17">Rule 17</a>).</p> (and in particular <a href="next/rules.html#rule17">Rule 17</a>).</p>
<div id="faq0_16"> <div id="faq0_16">
<div id="mkiocccentry_compile"> <div id="mkiocccentry_compile">
<h3 id="faq-0.16---how-to-i-compile-mkiocccentry-and-its-related-tools">FAQ 0.16 - How to I compile <code>mkiocccentry</code> and its related tools?</h3> <h3 id="faq-0.16---how-do-i-compile-mkiocccentry-and-its-related-tools">FAQ 0.16 - How do I compile <code>mkiocccentry</code> and its related tools?</h3>
</div> </div>
</div> </div>
<p>After you <p>After you
+12 -6
View File
@@ -20,7 +20,7 @@ This is FAQ version **28.0.3 2024-07-27**.
- <a class="normal" href="#faq0_13">0.13 - How can I validate my submission tarball?</a> - <a class="normal" href="#faq0_13">0.13 - How can I validate my submission tarball?</a>
- <a class="normal" href="#faq0_14">0.14 - What is the `fnamchk` tool?</a> - <a class="normal" href="#faq0_14">0.14 - What is the `fnamchk` tool?</a>
- <a class="normal" href="#faq0_15">0.15 - What is the `mkiocccentry` tool and how do I use it?</a> - <a class="normal" href="#faq0_15">0.15 - What is the `mkiocccentry` tool and how do I use it?</a>
- <a class="normal" href="#faq0_16">0.16 - How to I compile `mkiocccentry` and related tools?</a> - <a class="normal" href="#faq0_16">0.16 - How do I compile `mkiocccentry` and related tools?</a>
## Section 1 - [History of the IOCCC](#faq1) ## Section 1 - [History of the IOCCC](#faq1)
@@ -217,10 +217,10 @@ where:
Optional extra data files to include with your entry 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 **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, 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 installing it will make it easier for you as you can run it from your
submission's directory. 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 If you choose to risk violating rules, be sure an explain your reason
for doing so in your `remarks.md` file. 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 #### 6. Upload your entry to the IOCCC submit server
@@ -245,8 +247,10 @@ for an announcement of the availability of the **IOCCC submit server**.
<div id="faq0_1"> <div id="faq0_1">
<div id="frequent-themes">
### FAQ 0.1: What types of entries have been frequently submitted to the IOCCC? ### FAQ 0.1: What types of entries have been frequently submitted to the IOCCC?
</div> </div>
</div>
There are types of entries that are 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 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. 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 **IMPORTANT HINT**: It is **not fatal** to send in those types of
entries, it is just **HARDER to win** with such a submission. A 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.
<div id="faq0_3"> <div id="faq0_3">
<div id="prog">
### FAQ 0.3: May I use a different source or compiled filename than prog.c or prog? ### FAQ 0.3: May I use a different source or compiled filename than prog.c or prog?
</div> </div>
</div>
While your entry's source filename, as submitted, must be `prog.c`, your entry's `Makefile` 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: 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)
<div id="faq0_16"> <div id="faq0_16">
<div id="mkiocccentry_compile"> <div id="mkiocccentry_compile">
### FAQ 0.16 - How to I compile `mkiocccentry` and its related tools? ### FAQ 0.16 - How do I compile `mkiocccentry` and its related tools?
</div> </div>
</div> </div>