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

Update FAQ, guidelines and quick start

Browse Source 
This addresses most (if not all) of the recent changes to chkentry(1)
though a more thorough check will be made later after the mkiocccentry
code freeze.
This commit is contained in:
Cody Boone Ferguson committed 2025-02-27 14:56:01 -08:00
1 parent c5adf3016b
commit 65cf447087
6 files changed
+324 -236
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

quick-start.html
+29 -29
View File
@@ -424,6 +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 is quick start guide is version <strong>28.0.0 2025-02-27</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>
@@ -431,7 +432,7 @@
</div>
<p>To submit your code to the IOCCC, you <strong>MUST</strong> follow these steps:</p>
<div id="step_0">
<h4 id="verify-that-the-ioccc-is-pending-or-open-for-submissions">0. Verify that the IOCCC is pending or open for submissions</h4>
<h2 id="verify-that-the-ioccc-is-pending-or-open-for-submissions">0. Verify that the IOCCC is pending or open for submissions</h2>
</div>
<p>First, check the “<strong><a href="status.html">current status of the IOCCC</a></strong>” page to see current contest status.
You may <strong>only register for the IOCCC when the IOCCC is either <a href="status.html#pending">pending</a>
@@ -439,7 +440,7 @@ or <a href="status.html#open">open</a></strong>.</p>
<p>You may <strong>only submit your entries to the IOCCC when the IOCCC is <a href="status.html#open">open</a></strong>.</p>
<p>See also the <a href="news.html#news">IOCCC news</a> for more information.</p>
<div id="step_1">
<h4 id="read-the-latest-ioccc-rules-and-review-the-ioccc-guidelines">1. Read the latest IOCCC rules and review the IOCCC guidelines</h4>
<h2 id="read-the-latest-ioccc-rules-and-review-the-ioccc-guidelines">1. Read the latest IOCCC rules and review the IOCCC guidelines</h2>
</div>
<p>Please pay close attention to the <a href="next/rules.html">official IOCCC rules</a>.</p>
<p>You are also <strong>highly encouraged</strong> to review the
@@ -447,7 +448,7 @@ or <a href="status.html#open">open</a></strong>.</p>
suggestions, useful hints, and IOCCC humor. :-)</p>
<div id="step_2">
<div id="register">
<h4 id="register-for-the-ioccc">2. Register for the IOCCC</h4>
<h2 id="register-for-the-ioccc">2. Register for the IOCCC</h2>
</div>
</div>
<p><strong>IMPORTANT</strong>: You may <strong>only register for the IOCCC when the IOCCC is either <a href="status.html#pending">pending</a>
@@ -455,7 +456,7 @@ or <a href="status.html#open">open</a></strong>. See “<strong><a href="status.
<p>If the contest is <a href="status.html#pending">pending</a> or <a href="status.html#open">open</a>,
then follow the directions on “<strong><a href="next/register.html">how to register for the IOCCC</a></strong>”.</p>
<div id="step_3">
<h4 id="wait-for-your-submit-server-username-and-initial-password">3. Wait for your submit server username and initial password</h4>
<h2 id="wait-for-your-submit-server-username-and-initial-password">3. Wait for your submit server username and initial password</h2>
</div>
<p>Once you have <a href="next/register.html">registered for the IOCCC</a>,
and once the contest is <strong><a href="status.html#open">OPEN</a></strong>, one of the
@@ -477,7 +478,7 @@ password</strong>, and the <strong>CONTEST IS <a href="status.html#open">OPEN</a
have you checked your spam folder, <a href="contact.html">Contact the IOCCC</a>
for assistance.</p>
<div id="step_4">
<h4 id="login-to-the-submit-server-and-change-your-password">4. Login to the submit server and change your password</h4>
<h2 id="login-to-the-submit-server-and-change-your-password">4. Login to the submit server and change your password</h2>
</div>
<p>Using the <strong>Username</strong> and <strong>Initial password</strong> you receive via email in
<a href="#step_3">step 3</a>, you need to login to the <a href="https://submit.ioccc.org">IOCCC submit server</a>.</p>
@@ -487,7 +488,7 @@ from when one of the <a href="judges.html">IOCCC judges</a> sent that email.</p>
is only ready for submissions <strong>ONLY WHEN THE CONTEST IS <a href="status.html#open">open</a></strong>.</p>
<p>Please visit the “<strong><a href="next/pw-change.html">change your submit server initial password</a></strong>” page for detailed instructions.</p>
<div id="step_5">
<h4 id="obtain-and-compile-the-latest-mkiocccentry-toolkit">5. Obtain and compile the latest mkiocccentry toolkit</h4>
<h2 id="obtain-and-compile-the-latest-mkiocccentry-toolkit">5. Obtain and compile the latest mkiocccentry toolkit</h2>
</div>
<p>Once the contest is <a href="status.html#open">open</a>, download the most recent
version of the <a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry toolkit</a>.</p>
@@ -496,12 +497,14 @@ the <a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry toolkit</a>
could change. Once the content is <a href="status.html#open">open</a>, be sure
you <strong>have the latest</strong> version installed.</p>
<p>To help you, please see the
FAQ on “<a href="#obtaining_mkiocccentry">how to obtain the most recent mkiocccentry</a>”
FAQ on “<a href="faq.html#obtaining_mkiocccentry">how to obtain the most recent mkiocccentry</a>”,
the
FAQ on “<a href="faq.html#compiling_mkiocccentry">compiling mkiocccentry toolkit</a>”
and the
FAQ on “<a href="#compiling_mkiocccentry">compiling mkiocccentry toolkit</a>”,
FAQ on “<a href="faq.html#install">installing the mkiocccentry tools</a>”
for more details.</p>
<div id="step_6">
<h4 id="run-the-mkiocccentry-tool-to-form-your-submission-tarball">6. Run the mkiocccentry tool to form your submission tarball</h4>
<h2 id="run-the-mkiocccentry-tool-to-form-your-submission-tarball">6. Run the mkiocccentry tool to form your submission tarball</h2>
</div>
<p>For more details on <code>mkiocccentry</code>, what it is, how to obtain it and how to use
it, see the
@@ -525,7 +528,7 @@ guidelines</a>.</p>
<li><p><code>prog.c</code></p>
<p>path to the C source for your submission</p></li>
<li><p><code>Makefile</code></p>
<p>Makefile to build (make all) and cleanup (make clean &amp; make clobber) as well
<p>Makefile to build (make all) and clean up (make clean &amp; make clobber) as well
as the other required rules</p></li>
<li><p><code>remarks.md</code></p>
<p>Remarks about your entry in markdown format: see the
@@ -533,24 +536,6 @@ FAQ on “<a href="faq.html#remarks_md">remarks.md</a>”
for more info.</p></li>
</ul>
<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><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 <code>mkiocccentry</code> repo directory just fine, though
you’ll have to use the form of <code>./mkiocccentry</code> instead of just <code>mkiocccentry</code>.
However, installing it will make it easier for you as you can run it from your
submission’s directory. See the
FAQ on “<strong><a href="https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#install">installing mkiocccentry</a></strong>”
at the mkiocccentry repo.</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 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>. But even if you
have installed them but some tools are out of date (in the install path) it will
cause problems. Additionally, if you do not have the most recent version when
submitting a tarball it will be rejected for not having the right versions of
the tools. This is why you <strong>MUST</strong> make sure you have the most recent version
of all the tools and you either run it from the repo directory itself OR you
install them (<code>make install</code> as via <code>sudo</code> or as root). We recommend you install
the tools but if you wish to run it from the repo directory you may.</p>
<p>If the <code>mkiocccentry</code> tool indicates that there is a problem with your
submission, especially if it identifies a <a href="next/rules.html#rule2">Rule 2</a>, or
any other rule, related problem, you are <strong>strongly</strong> encouraged to revise and
@@ -558,9 +543,24 @@ correct your entry and then re-run the <code>mkiocccentry</code> tool.</p>
<p>If you choose to risk violating rules, 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
<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="rules.html#rule17">Rule 17</a>.
See the
FAQ on “<a href="faq.html#obtaining_mkiocccentry">obtaining the latest mkiocccentry tools</a>”,
the
FAQ on “<a href="faq.html#compiling_mkiocccentry">compiling the mkiocccentry tools</a>”,
the
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>
<div id="step_7">
<div id="submit">
<h4 id="upload-your-submission-to-the-ioccc-submit-server">7. Upload your submission to the IOCCC submit server</h4>
<h2 id="upload-your-submission-to-the-ioccc-submit-server">7. Upload your submission to the IOCCC submit server</h2>
</div>
</div>
<p>The screenshots on the “<strong><a href="next/submit.html">how to upload your submission to the IOCCC</a></strong>” page