mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add details on versions

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+25 -9
View File
@@ -425,7 +425,7 @@
<!-- BEFORE: 1st line of markdown file: faq.md -->
<h1 id="ioccc-faq-table-of-contents">IOCCC FAQ Table of Contents</h1>
<p>This is FAQ version <strong>28.2.15 2025-03-10</strong>.</p>
<p>This is FAQ version <strong>28.2.16 2025-03-12</strong>.</p>
<h2 id="entering-the-ioccc-the-bare-minimum-you-need-to-know">0. <a href="#enter_questions">Entering the IOCCC: the bare minimum you need to know</a></h2>
<ul>
<li><strong>Q 0.0</strong>: <a class="normal" href="#enter">How can I enter the IOCCC?</a></li>
@@ -436,6 +436,7 @@
<li><strong>Q 0.1.3</strong>: <a class="normal" href="#compiling_mkiocccentry">How do I compile the mkiocccentry toolkit?</a></li>
<li><strong>Q 0.1.4</strong>: <a class="normal" href="#install">How do I install mkiocccentry(1) and related tools?</a></li>
<li><strong>Q 0.1.5</strong>: <a class="normal" href="#using_mkiocccentry">How do I use mkiocccentry?</a></li>
<li><strong>Q 0.1.6</strong>: <a class="normal" href="#minimum_versions">What are the minimum versions required for this contest?</a></li>
</ul></li>
<li><strong>Q 0.2</strong>: <a class="normal" href="#platform">What platform should I assume for my submission?</a></li>
<li><strong>Q 0.3</strong>: <a class="normal" href="#makefile">What should I put in my submission Makefile?</a></li>
@@ -740,12 +741,11 @@ directory</strong> will be created, with the name based on your IOCCC registrati
username, which is <strong>in the form of a UUID</strong>, and submission number along with
the timestamp; see the <a href="next/rules.html">rules</a> for more details on this, and in
particular <a href="next/rules.html#rule17">Rule 17</a>.</p>
<p><strong>IMPORTANT NOTE</strong>: if you run the program outside the repo directory
(specifying the absolute or relative path to the tool) and you have not
installed the tools (and we <strong>STRONGLY</strong> recommend you <strong>do</strong> install them),
then you will have to specify the options for the tools that are required like
<code>chkentry(1)</code>, <code>txzchk(1)</code> and <code>fnamchk(1)</code>. And remember to make sure you have
the latest version so you do not violate <a href="next/rules.html#rule17">Rule 17</a>.</p>
<p><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>If the <strong><em>subdirectory</em> in the <em>work directory</em></strong> (based on your submit ID and
slot number) already exists, you will have to move it, remove it or otherwise
specify a different work directory (<strong>NOT</strong> the subdirectory), as it needs to be
@@ -760,8 +760,24 @@ looked at if the submission wins), run some tests and run a number of other
tools, as mentioned above, and as described in the “<a href="#mkiocccentry_details">finer
details</a>” section.</p>
<p>See also the
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md">mkiocccentry repo FAQ</a>
for more up to date information on downloading, compiling, and related FAQ information.</p>
FAQ on “<a href="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>Jump to: <a href="#">top</a></p>
<div id="minimum_versions">
<h4 id="q-0.1.6-what-are-the-minimum-versions-required-for-this-contest">Q 0.1.6: What are the minimum versions required for this contest?</h4>
</div>
<p>At minimum, the tools <strong>MUST</strong> be version:</p>
<ul>
<li><code>iocccsize(1)</code>: <code>"28.15 2024-06-27"</code>.</li>
<li><code>mkiocccentry(1)</code>: <code>"2.0.1 2025-03-02"</code>.</li>
<li><code>fnamchk(1)</code>: <code>"2.0.0 2025-02-28"</code>.</li>
<li><code>txzchk(1)</code>: <code>"2.0.1 2025-03-02"</code>.</li>
<li><code>chkentry(1)</code>: <code>"2.0.1 2025-03-02"</code>.</li>
</ul>
<p>See also the
FAQ on “<a href="#obtaining_mkiocccentry">obtaining the latest release of the toolkit</a>”.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="SUS">
<div id="platform">
faq.md
+30 -10
View File
@@ -1,6 +1,6 @@
# IOCCC FAQ Table of Contents
This is FAQ version **28.2.15 2025-03-10**.
This is FAQ version **28.2.16 2025-03-12**.
## 0. [Entering the IOCCC: the bare minimum you need to know](#enter_questions)
@@ -11,6 +11,7 @@ This is FAQ version **28.2.15 2025-03-10**.
- **Q 0.1.3**: <a class="normal" href="#compiling_mkiocccentry">How do I compile the mkiocccentry toolkit?</a>
- **Q 0.1.4**: <a class="normal" href="#install">How do I install mkiocccentry(1) and related tools?</a>
- **Q 0.1.5**: <a class="normal" href="#using_mkiocccentry">How do I use mkiocccentry?</a>
- **Q 0.1.6**: <a class="normal" href="#minimum_versions">What are the minimum versions required for this contest?</a>
- **Q 0.2**: <a class="normal" href="#platform">What platform should I assume for my submission?</a>
- **Q 0.3**: <a class="normal" href="#makefile">What should I put in my submission Makefile?</a>
- **Q 0.4**: <a class="normal" href="#remarks">What should I put in the remarks.md file of my submission?</a>
@@ -342,7 +343,6 @@ and will not work from any directory, however.
Jump to: [top](#)
<div id="using_mkiocccentry">
#### Q 0.1.5: How do I use mkiocccentry?
</div>
@@ -379,12 +379,11 @@ username, which is **in the form of a UUID**, and submission number along with
the timestamp; see the [rules](next/rules.html) for more details on this, and in
particular [Rule 17](next/rules.html#rule17).
**IMPORTANT NOTE**: if you run the program outside the repo directory
(specifying the absolute or relative path to the tool) and you have not
installed the tools (and we **STRONGLY** recommend you **do** install them),
then you will have to specify the options for the tools that are required like
`chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. And remember to make sure you have
the latest version so you do not violate [Rule 17](next/rules.html#rule17).
**IMPORTANT NOTE**: the tools that require other tools, `mkiocccentry(1)` and
`txzchk(1)`, will, as of version `2.0.2 2025-03-11`, search under `$PATH`. 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.
If the **_subdirectory_ in the _work directory_** (based on your submit ID and
slot number) already exists, you will have to move it, remove it or otherwise
@@ -402,11 +401,32 @@ tools, as mentioned above, and as described in the "[finer
details](#mkiocccentry_details)" section.
See also the
[mkiocccentry repo FAQ](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md)
for more up to date information on downloading, compiling, and related FAQ information.
FAQ on "[what the minimum required versions are for this
contest](minimum_versions)"
for more details on how to verify you have the correct versions for this
contest.
Jump to: [top](#)
<div id="minimum_versions">
#### Q 0.1.6: What are the minimum versions required for this contest?
</div>
At minimum, the tools **MUST** be version:
- `iocccsize(1)`: `"28.15 2024-06-27"`.
- `mkiocccentry(1)`: `"2.0.1 2025-03-02"`.
- `fnamchk(1)`: `"2.0.0 2025-02-28"`.
- `txzchk(1)`: `"2.0.1 2025-03-02"`.
- `chkentry(1)`: `"2.0.1 2025-03-02"`.
See also the
FAQ on "[obtaining the latest release of the toolkit](#obtaining_mkiocccentry)".
Jump to: [top](#)
<div id="SUS">
<div id="platform">
next/guidelines.html
+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
next/guidelines.md
+26 -6
View File
@@ -53,7 +53,7 @@ Jump to: [top](#)
</div>
<p class="leftbar">
These [IOCCC guidelines](guidelines.html) are version **28.45 2025-03-10**.
These [IOCCC guidelines](guidelines.html) are version **28.46 2025-03-12**.
</p>
<p class="leftbar">
@@ -149,6 +149,18 @@ to follow the guidelines. The options are in a release **AFTER THIS** IOCCC's
official release and not updating the toolkit is **PERFECTLY** okay.
</p>
<p class="leftbar">
**NOTE**: the updates to these guidelines on 2025-03-12 also explain how the
tools that require other tools now search under `$PATH`. 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 "[minimum required version of the tools](../faq.html#minimum_versions)"
for more details and the
FAQ on "[obtaining the most recent release of the
toolkit](../faq.html#obtaining_mkiocccentry)"
for more help.
</p>
<p class="leftbar">
Until the contest status becomes **[open](../faq.html#open)**,
the [IOCCC rules](rules.html),
@@ -195,11 +207,11 @@ We **STRONGLY** recommend you **do** install the
</p>
<p class="leftbar">
**IMPORTANT NOTE**: if you run an IOCCC related tool outside the
[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry)
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
`chkentry(1)`, `txzchk(1)` and `fnamchk(1)`.
**IMPORTANT NOTE**: the tools that require other tools, `mkiocccentry(1)` and
`txzchk(1)`, will, as of version `2.0.2 2025-03-11`, search under `$PATH`. 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">
@@ -213,6 +225,14 @@ as well as
[how to upload your submission](submit.html) to the IOCCC.
</p>
<p class="leftbar">
See also the
FAQ on "[what the minimum required versions are for this
contest](../faq.html#minimum_versions)"
for more details on how to verify you have the correct versions for this
contest.
</p>
<p class="leftbar">
While the contest is **[open](../faq.html#open)**, you may modify your
previously uploaded submission by rebuilding your submission with the
quick-start.html
+12 -5
View File
@@ -424,7 +424,7 @@
<!-- START: this line starts content for HTML phase 21 by: bin/pandoc-wrapper.sh via bin/md2html.sh -->
<!-- BEFORE: 1st line of markdown file: quick-start.md -->
<p>This quick start guide is version <strong>28.0.1 2025-03-01</strong>.</p>
<p>This quick start guide is version <strong>28.0.2 2025-03-12</strong>.</p>
<div id="enter_questions">
<div id="enter">
<h1 id="entering-the-ioccc-the-bare-minimum-you-need-to-know">Entering the IOCCC: the bare minimum you need to know</h1>
@@ -543,10 +543,12 @@ correct your entry and then re-run the <code>mkiocccentry</code> tool.</p>
<p>If you choose to risk violating <a href="next/rules.html">Rules</a>, be sure and explain your reason
for doing so in your <code>remarks.md</code> file.</p>
<p>See also <a href="next/rules.html#rule17">Rule 17</a>!</p>
<p><strong>IMPORTANT NOTE</strong>: if you run the program outside the repo directory
(specifying the absolute or relative path to the tool) and you have not
installed the tools (and we <strong>STRONGLY</strong> recommend you <strong>do</strong> install them),
then you will have to specify the options for the tools that are required like
<p><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>Do remember to make sure you have the latest vers
<code>chkentry(1)</code>, <code>txzchk(1)</code> and <code>fnamchk(1)</code>. And remember to make sure you have
the latest version so you do not violate <a href="next/rules.html#rule17">Rule 17</a>.
See the
@@ -558,6 +560,11 @@ FAQ on “<a href="faq.html#installing">installing the mkiocccentry tools</a>”
and the
FAQ on “<a href="faq.html#using_mkiocccentry">using the mkiocccentry tools</a>”
for more help.</p>
<p>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>
<div id="step_7">
<div id="submit">
<h2 id="upload-your-submission-to-the-ioccc-submit-server">7. Upload your submission to the IOCCC submit server</h2>
quick-start.md
+13 -5
View File
@@ -1,4 +1,4 @@
This quick start guide is version **28.0.1 2025-03-01**.
This quick start guide is version **28.0.2 2025-03-12**.
<div id="enter_questions">
<div id="enter">
@@ -170,10 +170,13 @@ for doing so in your `remarks.md` file.
See also [Rule 17](next/rules.html#rule17)!
**IMPORTANT NOTE**: if you run the program outside the repo directory
(specifying the absolute or relative path to the tool) and you have not
installed the tools (and we **STRONGLY** recommend you **do** install them),
then you will have to specify the options for the tools that are required like
**IMPORTANT NOTE**: the tools that require other tools, `mkiocccentry(1)` and
`txzchk(1)`, will, as of version `2.0.2 2025-03-11`, search under `$PATH`. 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.
Do remember to make sure you have the latest vers
`chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. And remember to make sure you have
the latest version so you do not violate [Rule 17](next/rules.html#rule17).
See the
@@ -186,6 +189,11 @@ and the
FAQ on "[using the mkiocccentry tools](faq.html#using_mkiocccentry)"
for more help.
See also the
FAQ on "[what the minimum required versions are for this
contest](faq.html#minimum_versions)"
for more details on how to verify you have the correct versions for this
contest.
<div id="step_7">
<div id="submit">