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

move IOCCC Quick Start Guide

Browse Source 
Created `quick-start.md` to hold the FAQ 0.0 content.

Used `sgit(1)` to change:

* faq.html#enter ==> quick-start.html#enter
* faq.html#enter_questions ==> quick-start.html#enter_questions
* faq.html#step_0 ==> quick-start.html#step_0
* faq.html#step_1 ==> quick-start.html#step_1
* faq.html#step_2 ==> quick-start.html#step_2
* faq.html#register ==> quick-start.html#register
* faq.html#step_3 ==> quick-start.html#step_3
* faq.html#step_4 ==> quick-start.html#step_4
* faq.html#step_5 ==> quick-start.html#step_5
* faq.html#step_6 ==> quick-start.html#step_6
* faq.html#step_7 ==> quick-start.html#step_7
* faq.html#step_submit ==> quick-start.html#step_submit

Via:

```sh
sgit -e 's/faq\.html#enter/quick-start.html#enter/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#enter_questions/quick-start.html#enter_questions/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_0/quick-start.html#step_0/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_1/quick-start.html#step_1/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_2/quick-start.html#step_2/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#register/quick-start.html#register/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_3/quick-start.html#step_3/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_4/quick-start.html#step_4/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_5/quick-start.html#step_5/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_6/quick-start.html#step_6/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_7/quick-start.html#step_7/g' '*.md' '*.hdr' 'inc/*.html'
sgit -e 's/faq\.html#step_submit/quick-start.html#step_submit/g' '*.md' '*.hdr' 'inc/*.html'
```

The former FAQ 0.0 section in `faq.html` now just refers to `quick-start.html`.

Modified menu and non-JS menu so that "Enter the IOCCC" refers to `quick-start.html`.

Changed `bin/gen-top-html.sh` VERSION from "1.4.10 2024-11-23"
to "1.4.11 2025-01-09".

Performed `make www` on macOS to complete the above.
This commit is contained in:
Landon Curt Noll committed 2025-01-09 23:11:43 -08:00
1 parent d1e28658f9
commit 11dfe51c6c
433 files changed
+1764 -1198
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+13 -130
View File
@@ -150,7 +150,7 @@
</div>
<div class="outfit-font">
<a href="./faq.html#enter" class="sub-item-link">
<a href="./quick-start.html#enter" class="sub-item-link">
Enter the IOCCC
</a>
</div>
@@ -318,7 +318,7 @@
Frequently Asked Questions
</a>
<a class="mobile-submenu-item" href="./faq.html#enter">
<a class="mobile-submenu-item" href="./quick-start.html#enter">
Enter the IOCCC
</a>
@@ -575,147 +575,30 @@
<div id="enter_questions">
<h2 id="section-0-entering-the-ioccc-the-bare-minimum-you-need-to-know">Section 0: Entering the IOCCC: the bare minimum you need to know</h2>
</div>
<p>Jump to: <a href="#">top</a></p>
<div id="enter">
<h3 id="q-0.0-how-can-i-enter-the-ioccc">Q 0.0: How can I enter the IOCCC?</h3>
</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>
</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>
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>
</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
<a href="next/guidelines.html">official IOCCC guidelines</a> as they contain important
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>
</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>
or <a href="status.html#open">open</a></strong>. See “<strong><a href="status.html">current status of the IOCCC</a></strong>” page for details.</p>
<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>
</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
<a href="judges.html">IOCCC judges</a> will send via email within a few days,
your <a href="https://submit.ioccc.org">IOCCC submit server</a> <strong>Username</strong> and
<strong>Initial password</strong>.</p>
<p><strong>PLEASE NOTE</strong>: After registering, it could take up to a <strong>few days</strong>
before an <a href="judges.html">IOCCC judge</a> sends the that email, so <strong>PLEASE
be patient</strong>. This means that you should <strong>GIVE YOURSELF TIME</strong> before the
contest closes!</p>
<p><strong>IMPORTANT NOTE</strong>: Unless the contest is <a href="status.html#open">open</a>,
then you will <strong>NOT</strong> receive your <strong>Username</strong> and <strong>Initial password</strong>
by email. For example, if the contest is <a href="status.html#pending">pending</a>,
you will have to <strong>WAIT UNTIL THE CONTEST IS <a href="status.html#open">OPEN</a></strong>.</p>
<p>Please check the “<strong><a href="status.html">current status of the IOCCC</a></strong>” page and
visit the “<strong><a href="next/register.html">how to register for the IOCCC</a></strong>” page for detailed instructions.</p>
<p><strong>NOTE</strong>: If are having trouble receiving your <strong>Username</strong> and <strong>Initial
password</strong>, and the <strong>CONTEST IS <a href="status.html#open">OPEN</a></strong>, and
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>
</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>
<p><strong>IMPORTANT NOTE</strong>: You must change your password <strong>WITHIN 72 HOURS</strong>
from when one of the <a href="judges.html">IOCCC judges</a> sent that email.</p>
<p><strong>NOTE</strong>: The <a href="https://submit.ioccc.org">IOCCC submit server</a>
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>
</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>
<p><strong>IMPORTANT NOTE</strong>: While the contest is <a href="status.html#pending">pending</a>,
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>”
and the
FAQ on “<a href="#compiling_mkiocccentry">compiling mkiocccentry toolkit</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>
</div>
<p>For more details on <code>mkiocccentry</code>, what it is, how to obtain it and how to use
it, see the
FAQ on “<a href="#mkiocccentry">mkiocccentry</a>”
(especially the
FAQ on “<a href="#about_mkiocccentry">what mkiocccentry is in simple terms</a>,
the
FAQ on”<a href="#using_mkiocccentry">how to use mkiocccentry</a>“)
and the <a href="next/guidelines.html#mkiocccentry">mkiocccentry section in the
guidelines</a>.</p>
<pre><code> mkiocccentry work_dir prog.c Makefile remarks.md [file ...]</code></pre>
<p>where:</p>
<ul>
<li><p><code>work_dir</code></p>
<p>directory where the entry directory and tarball are formed</p></li>
<li><p><code>prog.c</code></p>
<p>path to the C source for your entry</p></li>
<li><p><code>Makefile</code></p>
<p>Makefile to build (make all) and cleanup (make clean &amp; make clobber)</p></li>
<li><p><code>remarks.md</code></p>
<p>Remarks about your entry in markdown format: see the
FAQ on “<a href="#remarks_md">remarks.md</a>”
for more info.</p></li>
<li><p>[file …]</p>
<p>Optional extra data files to include with your entry</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>If the <code>mkiocccentry</code> tool indicates that there is a problem with your entry,
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 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>
<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>
<h3 id="q-0.0-how-can-i-enter-the-ioccc">Q 0.0: How can I enter the IOCCC?</h3>
</div>
</div>
<p>The screenshots on the “<strong><a href="next/submit.html">how to upload your submission to the IOCCC</a></strong>” page
might be a helpful guide when using the <a href="https://submit.ioccc.org">IOCCC submit server</a>.</p>
<p><strong>NOTE</strong>: You may modify a previous uploaded submission, if the contest is
<a href="status.html#open">open</a>, by replacing the file in a slot. Please use the
<a href="#mkiocccentry">mkiocccentry tool</a> to rebuild the compressed tarball as
this will update the timestamps and the filename generated, as well as packaging
any changes: making it clear to the <a href="judges.html">IOCCC judges</a> that you intend
to replace the older upload.</p>
<p><strong>IMPORTANT NOTE</strong>: The <a href="https://submit.ioccc.org">IOCCC submit server</a>
is only ready for submissions
<strong>ONLY WHEN THE CONTEST IS <a href="status.html#open">open</a></strong>.</p>
<p>See the “<strong><a href="status.html">current status of the IOCCC</a></strong>” page for details on the contest status.</p>
<p><strong>IMPORTANT NOTE</strong>: When the contest is <a href="status.html#closed">closed</a>, the
<a href="https://submit.ioccc.org">IOCCC submit server</a>
might be offline and unreachable as a website.</p>
<p><strong>NOTE</strong>: if you do need to update a submission, you might find the
FAQ on “<a href="#answers_file">how to not have to re-enter information more than once</a>”
useful.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<p>To submit your code to the IOCCC, <strong>follow the</strong> <a href="quick-start.html">IOCCC Quick Start Guide</a>.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="what_mkiocccentry">
<div id="mkiocccentry">