move IOCCC Quick Start Guide
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
1 parent
d1e28658f9
commit
11dfe51c6c
433 files changed
+1764
-1198
No files matched your search
+203
@@ -0,0 +1,203 @@
|
||||
<div id="enter_questions">
|
||||
<div id="enter">
|
||||
# Entering the IOCCC: the bare minimum you need to know
|
||||
</div>
|
||||
</div>
|
||||
|
||||
To submit your code to the IOCCC, you **MUST** follow these steps:
|
||||
|
||||
|
||||
<div id="step_0">
|
||||
#### 0. Verify that the IOCCC is pending or open for submissions
|
||||
</div>
|
||||
|
||||
First, check the "**[current status of the IOCCC](status.html)**" page to see current contest status.
|
||||
You may **only register for the IOCCC when the IOCCC is either [pending](status.html#pending)
|
||||
or [open](status.html#open)**.
|
||||
|
||||
You may **only submit your entries to the IOCCC when the IOCCC is [open](status.html#open)**.
|
||||
|
||||
See also the [IOCCC news](news.html#news) for more information.
|
||||
|
||||
|
||||
<div id="step_1">
|
||||
#### 1. Read the latest IOCCC rules and review the IOCCC guidelines
|
||||
</div>
|
||||
|
||||
Please pay close attention to the [official IOCCC rules](next/rules.html).
|
||||
|
||||
You are also **highly encouraged** to review the
|
||||
[official IOCCC guidelines](next/guidelines.html) as they contain important
|
||||
suggestions, useful hints, and IOCCC humor. :-)
|
||||
|
||||
|
||||
<div id="step_2">
|
||||
<div id="register">
|
||||
#### 2. Register for the IOCCC
|
||||
</div>
|
||||
</div>
|
||||
|
||||
**IMPORTANT**: You may **only register for the IOCCC when the IOCCC is either [pending](status.html#pending)
|
||||
or [open](status.html#open)**. See "**[current status of the IOCCC](status.html)**" page for details.
|
||||
|
||||
If the contest is [pending](status.html#pending) or [open](status.html#open),
|
||||
then follow the directions on "**[how to register for the IOCCC](next/register.html)**".
|
||||
|
||||
|
||||
<div id="step_3">
|
||||
#### 3. Wait for your submit server username and initial password
|
||||
</div>
|
||||
|
||||
Once you have [registered for the IOCCC](next/register.html),
|
||||
and once the contest is **[OPEN](status.html#open)**, one of the
|
||||
[IOCCC judges](judges.html) will send via email within a few days,
|
||||
your [IOCCC submit server](https://submit.ioccc.org) **Username** and
|
||||
**Initial password**.
|
||||
|
||||
**PLEASE NOTE**: After registering, it could take up to a **few days**
|
||||
before an [IOCCC judge](judges.html) sends the that email, so **PLEASE
|
||||
be patient**. This means that you should **GIVE YOURSELF TIME** before the
|
||||
contest closes!
|
||||
|
||||
**IMPORTANT NOTE**: Unless the contest is [open](status.html#open),
|
||||
then you will **NOT** receive your **Username** and **Initial password**
|
||||
by email. For example, if the contest is [pending](status.html#pending),
|
||||
you will have to **WAIT UNTIL THE CONTEST IS [OPEN](status.html#open)**.
|
||||
|
||||
Please check the "**[current status of the IOCCC](status.html)**" page and
|
||||
visit the "**[how to register for the IOCCC](next/register.html)**" page for detailed instructions.
|
||||
|
||||
**NOTE**: If are having trouble receiving your **Username** and **Initial
|
||||
password**, and the **CONTEST IS [OPEN](status.html#open)**, and
|
||||
have you checked your spam folder, [Contact the IOCCC](contact.html)
|
||||
for assistance.
|
||||
|
||||
|
||||
<div id="step_4">
|
||||
#### 4. Login to the submit server and change your password
|
||||
</div>
|
||||
|
||||
Using the **Username** and **Initial password** you receive via email in
|
||||
[step 3](#step_3), you need to login to the [IOCCC submit server](https://submit.ioccc.org).
|
||||
|
||||
**IMPORTANT NOTE**: You must change your password **WITHIN 72 HOURS**
|
||||
from when one of the [IOCCC judges](judges.html) sent that email.
|
||||
|
||||
**NOTE**: The [IOCCC submit server](https://submit.ioccc.org)
|
||||
is only ready for submissions **ONLY WHEN THE CONTEST IS [open](status.html#open)**.
|
||||
|
||||
Please visit the "**[change your submit server initial password](next/pw-change.html)**" page for detailed instructions.
|
||||
|
||||
|
||||
<div id="step_5">
|
||||
#### 5. Obtain and compile the latest mkiocccentry toolkit
|
||||
</div>
|
||||
|
||||
Once the contest is [open](status.html#open), download the most recent
|
||||
version of the [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry).
|
||||
|
||||
**IMPORTANT NOTE**: While the contest is [pending](status.html#pending),
|
||||
the [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry)
|
||||
could change. Once the content is [open](status.html#open), be sure
|
||||
you **have the latest** version installed.
|
||||
|
||||
To help you, please see the
|
||||
FAQ on "[how to obtain the most recent mkiocccentry](#obtaining_mkiocccentry)"
|
||||
and the
|
||||
FAQ on "[compiling mkiocccentry toolkit](#compiling_mkiocccentry)",
|
||||
for more details.
|
||||
|
||||
|
||||
<div id="step_6">
|
||||
#### 6. Run the mkiocccentry tool to form your submission tarball
|
||||
</div>
|
||||
|
||||
For more details on `mkiocccentry`, what it is, how to obtain it and how to use
|
||||
it, see the
|
||||
FAQ on "[mkiocccentry](#mkiocccentry)"
|
||||
(especially the
|
||||
FAQ on "[what mkiocccentry is in simple terms](#about_mkiocccentry),
|
||||
the
|
||||
FAQ on "[how to use mkiocccentry](#using_mkiocccentry)")
|
||||
and the [mkiocccentry section in the
|
||||
guidelines](next/guidelines.html#mkiocccentry).
|
||||
|
||||
|
||||
``` <!---sh-->
|
||||
mkiocccentry work_dir prog.c Makefile remarks.md [file ...]
|
||||
```
|
||||
|
||||
where:
|
||||
|
||||
* `work_dir`
|
||||
|
||||
directory where the entry directory and tarball are formed
|
||||
|
||||
* `prog.c`
|
||||
|
||||
path to the C source for your entry
|
||||
|
||||
* `Makefile`
|
||||
|
||||
Makefile to build (make all) and cleanup (make clean & make clobber)
|
||||
|
||||
* `remarks.md`
|
||||
|
||||
Remarks about your entry in markdown format: see the
|
||||
FAQ on "[remarks.md](#remarks_md)"
|
||||
for more info.
|
||||
|
||||
* [file ...]
|
||||
|
||||
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**: 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, though
|
||||
you'll have to use the form of `./mkiocccentry` instead of just `mkiocccentry`.
|
||||
However, installing it will make it easier for you as you can run it from your
|
||||
submission's directory. See the
|
||||
FAQ on "**[installing mkiocccentry](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#install)**"
|
||||
at the mkiocccentry repo.
|
||||
|
||||
If the `mkiocccentry` tool indicates that there is a problem with your entry,
|
||||
especially if it identifies a [Rule 2](next/rules.html#rule2), or any other
|
||||
rule, related problem, you are **strongly** encouraged to revise and correct
|
||||
your entry and then re-run the `mkiocccentry` tool.
|
||||
|
||||
If you choose to risk violating rules, be sure and explain your reason
|
||||
for doing so in your `remarks.md` file.
|
||||
|
||||
See also [Rule 17](next/rules.html#rule17)!
|
||||
|
||||
|
||||
<div id="step_7">
|
||||
<div id="submit">
|
||||
#### 7. Upload your submission to the IOCCC submit server
|
||||
</div>
|
||||
</div>
|
||||
|
||||
The screenshots on the "**[how to upload your submission to the IOCCC](next/submit.html)**" page
|
||||
might be a helpful guide when using the [IOCCC submit server](https://submit.ioccc.org).
|
||||
|
||||
**NOTE**: You may modify a previous uploaded submission, if the contest is
|
||||
[open](status.html#open), by replacing the file in a slot. Please use the
|
||||
[mkiocccentry tool](#mkiocccentry) 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 [IOCCC judges](judges.html) that you intend
|
||||
to replace the older upload.
|
||||
|
||||
**IMPORTANT NOTE**: The [IOCCC submit server](https://submit.ioccc.org)
|
||||
is only ready for submissions
|
||||
**ONLY WHEN THE CONTEST IS [open](status.html#open)**.
|
||||
|
||||
See the "**[current status of the IOCCC](status.html)**" page for details on the contest status.
|
||||
|
||||
**IMPORTANT NOTE**: When the contest is [closed](status.html#closed), the
|
||||
[IOCCC submit server](https://submit.ioccc.org)
|
||||
might be offline and unreachable as a website.
|
||||
|
||||
**NOTE**: if you do need to update a submission, you might find the
|
||||
FAQ on "[how to not have to re-enter information more than once](#answers_file)"
|
||||
useful.
|
||||
Reference in new issue
Block a user