Add details on versions

New FAQ on what the minimum versions are (this should be updated every
contest or updated to refer to the result of the issue I opened at the
other repo - post IOCCC28) for each tool.

Added details about the new (soon to be released) version of the tools
that now search under $PATH.

This commit updated the FAQ, the guidelines and the quick start guide.

As a reminder you do NOT need to use the upcoming release of the tools
and not doing so will not invalidate any of your submissions as it is
based on a minimum version, not an exact version.
This commit is contained in:
Cody Boone Ferguson committed 2025-03-12 03:27:58 -07:00
1 parent 8968cf8904
commit 864f17e4a5
6 files changed
+130 -41

No files matched your search

+24 -6
View File
@@ -464,7 +464,7 @@ writing by <a href="../contact.html">contacting the judges</a>.</p>
</div>
</div>
<p class="leftbar">
These <a href="guidelines.html">IOCCC guidelines</a> are version <strong>28.45 2025-03-10</strong>.
These <a href="guidelines.html">IOCCC guidelines</a> are version <strong>28.46 2025-03-12</strong>.
</p>
<p class="leftbar">
The markdown form of these guidelines <a href="guidelines.md"
@@ -537,6 +537,17 @@ to follow the guidelines. The options are in a release <strong>AFTER THIS</stron
official release and not updating the toolkit is <strong>PERFECTLY</strong> okay.
</p>
<p class="leftbar">
<strong>NOTE</strong>: the updates to these guidelines on 2025-03-12 also explain how the
tools that require other tools now search under <code>$PATH</code>. It is perfectly fine to
not use the newer versions so long as you use the minimum required version of
the tools. See the
FAQ on “<a href="../faq.html#minimum_versions">minimum required version of the tools</a>”
for more details and the
FAQ on “<a href="../faq.html#obtaining_mkiocccentry">obtaining the most recent release of the
toolkit</a>”
for more help.
</p>
<p class="leftbar">
Until the contest status becomes <strong><a href="../faq.html#open">open</a></strong>,
the <a href="rules.html">IOCCC rules</a>,
<a href="guidelines.html">IOCCC guidelines</a> and the tools in the
@@ -577,11 +588,11 @@ We <strong>STRONGLY</strong> recommend you <strong>do</strong> install the
<a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry toolkit</a>.
</p>
<p class="leftbar">
<strong>IMPORTANT NOTE</strong>: if you run an IOCCC related tool outside the
<a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry toolkit</a>
directory and you have not installed those tools, then you will have to
specify the options (such as paths) for the tools that are required like
<code>chkentry(1)</code>, <code>txzchk(1)</code> and <code>fnamchk(1)</code>.
<strong>IMPORTANT NOTE</strong>: the tools that require other tools, <code>mkiocccentry(1)</code> and
<code>txzchk(1)</code>, will, as of version <code>2.0.2 2025-03-11</code>, search under <code>$PATH</code>. If
you have an earlier version and you have not installed the tools and run the
tools from outside the repo directory, you will have to use the options to the
tools to set the path to the required tools.
</p>
<p class="leftbar">
See the
@@ -594,6 +605,13 @@ as well as
<a href="submit.html">how to upload your submission</a> to the IOCCC.
</p>
<p class="leftbar">
See also the
FAQ on “<a href="../faq.html#minimum_versions">what the minimum required versions are for this
contest</a>”
for more details on how to verify you have the correct versions for this
contest.
</p>
<p class="leftbar">
While the contest is <strong><a href="../faq.html#open">open</a></strong>, you may modify your
previously uploaded submission by rebuilding your submission with the
<code>mkiocccentry(1)</code> tool and then re-uploading it to <strong>the same slot number</strong> on the