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

improve bottom of index.html and FAQ 0.0

Browse Source 
Improved information on how to view the status of the IOCCC, directing
people to `status.html` (which includes a copy of the contents of
`status.json`) instead of directly referring people to `status.json`.

Improved format of "FAQ 0.0: How may I submit to the IOCCC?".

Improved bottom of `index.html` to refer to the above.
This commit is contained in:
Landon Curt Noll committed 2024-05-29 13:57:21 -07:00
1 parent 2869852831
commit d70b6681d1
4 files changed
+141 -126
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+38 -35
View File
@@ -481,19 +481,17 @@ other inconsistencies with the original entry?</a></li>
</div> </div>
</div> </div>
<p>To submit your code to the IOCCC, you <strong>MUST</strong> follow these steps:</p> <p>To submit your code to the IOCCC, you <strong>MUST</strong> follow these steps:</p>
<ol start="0" type="1"> <h4 id="verify-that-the-ioccc-is-open-for-submissions">0. Verify that the IOCCC is open for submissions</h4>
<li><p>Verify that the IOCCC is open for submissions</p> <p>Check the <a href="status.html">current status of the IOCCC</a> see of the IOCCC is open.</p>
<p>Check the <a href="status.json">status.json</a> URL and <p>You may <strong>only register for the IOCCC when the IOCCC is OPEN</strong>.</p>
check the <a href="news.html#news">IOCCC news</a> to <p>You may <strong>only submit your entries to the IOCCC when the IOCCC is OPEN</strong>.</p>
see of the IOCCC is open.</p> <p>See also the <a href="news.html#news">IOCCC news</a> for more information.</p>
<p>You may only register for the IOCCC <h4 id="read-the-latest-ioccc-rules-and-review-the-ioccc-guidelines">1. Read the latest IOCCC rules and review the IOCCC guidelines</h4>
and you may only submit your entries to the IOCCC when the IOCCC is <strong>OPEN</strong>.</p></li>
<li><p>Read the latest IOCCC rules and review the IOCCC guidelines</p>
<p>Please pay close attention to the <a href="next/rules.html">official IOCCC rules</a>.</p> <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 <p>You are also <strong>highly encouraged</strong> to review the
<a href="next/guidelines.html">official IOCCC guidelines</a> as they contain important <a href="next/guidelines.html">official IOCCC guidelines</a> as they contain important
suggestions, useful hints, and IOCCC humor. :-)</p></li> suggestions, useful hints, and IOCCC humor. :-)</p>
<li><p>Register for the IOCCC</p> <h4 id="register-for-the-ioccc">2. Register for the IOCCC</h4>
<p>The <strong>IOCCC registration procedure</strong> is still being designed. <p>The <strong>IOCCC registration procedure</strong> is still being designed.
<!--XXX--> As such, we do not yet have instructions on how to <!--XXX--> As such, we do not yet have instructions on how to
use the <strong>IOCCC registration procedure</strong>. Once <strong>IOCCC use the <strong>IOCCC registration procedure</strong>. Once <strong>IOCCC
@@ -502,28 +500,34 @@ with the proper instructions. Watch the <a href="news.html">IOCCC news</a>
for an annoucement about the <strong>IOCCC registration procedure</strong>.</p> for an annoucement about the <strong>IOCCC registration procedure</strong>.</p>
<p>Once you have been registered, you will receive an email message for how to <p>Once you have been registered, you will receive an email message for how to
prepare your entries for submission, and how to upload the compressed tarballs prepare your entries for submission, and how to upload the compressed tarballs
to our submission portal.</p></li> to our submission portal.</p>
<li><p>Obtain the latest mkiocccentry toolkit</p> <h4 id="obtain-the-latest-mkiocccentry-toolkit">3. Obtain the latest mkiocccentry toolkit</h4>
<p>If you do not have an mkiocccentry tool directory:</p> <p>If you do not have an mkiocccentry tool directory:</p>
<p>cd some_directory <div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a> <span class="bu">cd</span> some_directory</span>
git clone git@github.com:ioccc-src/mkiocccentry.git <span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">git</span> clone git@github.com:ioccc-src/mkiocccentry.git</span>
cd mkiocccentry</p> <span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> <span class="bu">cd</span> mkiocccentry</span></code></pre></div>
<p>If you already have an mkiocccentry tool directory:</p> <p>If you already have an mkiocccentry tool directory:</p>
<p>cd mkiocccentry <div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a> <span class="bu">cd</span> mkiocccentry</span>
git fetch <span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">git</span> fetch</span>
git rebase</p></li> <span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">git</span> rebase</span></code></pre></div>
<li><p>Make the mkiocccentry toolkit</p> <h4 id="make-the-mkiocccentry-toolkit">4. Make the mkiocccentry toolkit</h4>
<p>make clobber all</p></li> <div class="sourceCode" id="cb3"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a> <span class="fu">make</span> clobber all</span></code></pre></div>
<li><p>Run the mkiocccentry tool to form your entry tarball</p> <h4 id="run-the-mkiocccentry-tool-to-form-your-entry-tarball">5. Run the mkiocccentry tool to form your entry tarball</h4>
<p>./mkiocccentry work_dir prog.c Makefile remarks.md [file …]</p> <div class="sourceCode" id="cb4"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a> <span class="ex">mkiocccentry</span> work_dir prog.c Makefile remarks.md [file ...]</span></code></pre></div>
<p>where:</p> <p>where:</p>
<p>work_dir directory where the entry directory and tarball are formed <ul>
prog.c path to the C source for your entry</p> <li><p>work_dir</p>
<p>Makefile Makefile to build (make all) and cleanup (make clean &amp; make clobber)</p> <p>directory where the entry directory and tarball are formed</p></li>
<p>remarks.md Remarks about your entry in markdown format: see <a href="#remarks_md">FAQ 2.1</a> for more info.</p> <li><p>prog.c</p>
<pre><code> NOTE: See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide. <p>path to the C source for your entry</p></li>
See also [CommonMark Spec](https://spec.commonmark.org/current/).</code></pre> <li><p>Makefile</p>
<p>[file …] extra data files to include with your entry</p> <p>Makefile to build (make all) and cleanup (make clean &amp; make clobber)</p></li>
<li><p>remarks.md</p>
<p>Remarks about your entry in markdown format: see <a href="#remarks_md">FAQ 2.1</a> for more info.</p></li>
<li><p>[file …]</p>
<p>Optional extra data files to include with your entry</p></li>
</ul>
<p>NOTE: Please see our <a href="markdown.html">IOCCC markdown guide</a> for <strong>important information</strong> on using markdown in the IOCCC.</p>
<p>NOTE: It is <em>NOT</em> necessary to install the tools to use them as you can run <p>NOTE: It is <em>NOT</em> necessary to install the tools to use them as you can run
the tools from the top of the <em>mkiocccentry repo</em> directory just fine.</p> the tools from the top of the <em>mkiocccentry repo</em> directory just fine.</p>
<p>If <code>mkiocccentry</code> tool indicates that there is a problem with your entry, <p>If <code>mkiocccentry</code> tool indicates that there is a problem with your entry,
@@ -531,15 +535,14 @@ especially if it identifies a <a href="next/rules.html#2">rule 2</a> related pro
you are <strong>strongly</strong> encouraged to revise and correct your entry and you are <strong>strongly</strong> encouraged to revise and correct your entry and
then re-run the <code>mkiocccentry</code> tool.</p> then re-run the <code>mkiocccentry</code> tool.</p>
<p>If you choose to risk violating rules, be sure an explain your reason <p>If you choose to risk violating rules, be sure an explain your reason
for doing so in your <code>remarks.md</code> file.</p></li> for doing so in your <code>remarks.md</code> file.</p>
<li><p>Upload your entry to the IOCCC submit server</p> <h4 id="upload-your-entry-to-the-ioccc-submit-server">6. Upload your entry to the IOCCC submit server</h4>
<p>The <strong>IOCCC submit server</strong> is still being written as of 2024 <p>The <strong>IOCCC submit server</strong> is still being written.
Mar 10. <!--XXX--> As such, we do not yet have instructions <!--XXX--> As such, we do not yet have instructions
on how upload your entry to the <strong>IOCCC submit server</strong>. Once on how upload your entry to the <strong>IOCCC submit server</strong>. Once
<strong>IOCCC submit server</strong> is ready, we will update this section <strong>IOCCC submit server</strong> is ready, we will update this section
with the proper instructions. Watch the <a href="news.html">IOCCC news</a> with the proper instructions. Watch the <a href="news.html">IOCCC news</a>
for an annoucement of the availability of the <strong>IOCCC submit server</strong>.</p></li> for an annoucement of the availability of the <strong>IOCCC submit server</strong>.</p>
</ol>
<div id="faq0_1"> <div id="faq0_1">
<h3 id="faq-0.1-what-types-of-entries-have-been-frequently-submitted-to-the-ioccc">FAQ 0.1: What types of entries have been frequently submitted to the IOCCC?</h3> <h3 id="faq-0.1-what-types-of-entries-have-been-frequently-submitted-to-the-ioccc">FAQ 0.1: What types of entries have been frequently submitted to the IOCCC?</h3>
</div> </div>
faq.md
+94 -71
View File
@@ -105,92 +105,115 @@ other inconsistencies with the original entry?](#faq4_3)
To submit your code to the IOCCC, you **MUST** follow these steps: To submit your code to the IOCCC, you **MUST** follow these steps:
0. Verify that the IOCCC is open for submissions
Check the [status.json](status.json) URL and #### 0. Verify that the IOCCC is open for submissions
check the [IOCCC news](news.html#news) to
see of the IOCCC is open.
You may only register for the IOCCC Check the [current status of the IOCCC](status.html) see of the IOCCC is open.
and you may only submit your entries to the IOCCC when the IOCCC is **OPEN**.
1. Read the latest IOCCC rules and review the IOCCC guidelines You may **only register for the IOCCC when the IOCCC is OPEN**.
Please pay close attention to the [official IOCCC rules](next/rules.html). You may **only submit your entries to the IOCCC when the IOCCC is OPEN**.
You are also **highly encouraged** to review the See also the [IOCCC news](news.html#news) for more information.
[official IOCCC guidelines](next/guidelines.html) as they contain important
suggestions, useful hints, and IOCCC humor. :-)
2. Register for the IOCCC
The **IOCCC registration procedure** is still being designed.
<!--XXX--> As such, we do not yet have instructions on how to
use the **IOCCC registration procedure**. Once **IOCCC
registration procedure** is ready, we will update this section
with the proper instructions. Watch the [IOCCC news](news.html)
for an annoucement about the **IOCCC registration procedure**.
Once you have been registered, you will receive an email message for how to
prepare your entries for submission, and how to upload the compressed tarballs
to our submission portal.
3. Obtain the latest mkiocccentry toolkit
If you do not have an mkiocccentry tool directory:
cd some_directory
git clone git@github.com:ioccc-src/mkiocccentry.git
cd mkiocccentry
If you already have an mkiocccentry tool directory:
cd mkiocccentry
git fetch
git rebase
4. Make the mkiocccentry toolkit
make clobber all
5. Run the mkiocccentry tool to form your entry tarball
./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) #### 1. Read the latest IOCCC rules and review the IOCCC guidelines
remarks.md Remarks about your entry in markdown format: see [FAQ 2.1](#remarks_md) for more info. Please pay close attention to the [official IOCCC rules](next/rules.html).
NOTE: See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide. You are also **highly encouraged** to review the
See also [CommonMark Spec](https://spec.commonmark.org/current/). [official IOCCC guidelines](next/guidelines.html) as they contain important
suggestions, useful hints, and IOCCC humor. :-)
[file ...] extra data files to include with your entry
NOTE: It is *NOT* necessary to install the tools to use them as you can run #### 2. Register for the IOCCC
the tools from the top of the _mkiocccentry repo_ directory just fine.
If `mkiocccentry` tool indicates that there is a problem with your entry, The **IOCCC registration procedure** is still being designed.
especially if it identifies a [rule 2](next/rules.html#2) related problem, <!--XXX--> As such, we do not yet have instructions on how to
you are **strongly** encouraged to revise and correct your entry and use the **IOCCC registration procedure**. Once **IOCCC
then re-run the `mkiocccentry` tool. registration procedure** is ready, we will update this section
with the proper instructions. Watch the [IOCCC news](news.html)
for an annoucement about the **IOCCC registration procedure**.
If you choose to risk violating rules, be sure an explain your reason Once you have been registered, you will receive an email message for how to
for doing so in your `remarks.md` file. prepare your entries for submission, and how to upload the compressed tarballs
to our submission portal.
6. Upload your entry to the IOCCC submit server
The **IOCCC submit server** is still being written as of 2024 #### 3. Obtain the latest mkiocccentry toolkit
Mar 10. <!--XXX--> As such, we do not yet have instructions
on how upload your entry to the **IOCCC submit server**. Once If you do not have an mkiocccentry tool directory:
**IOCCC submit server** is ready, we will update this section
with the proper instructions. Watch the [IOCCC news](news.html) ```sh
for an annoucement of the availability of the **IOCCC submit server**. cd some_directory
git clone git@github.com:ioccc-src/mkiocccentry.git
cd mkiocccentry
```
If you already have an mkiocccentry tool directory:
```sh
cd mkiocccentry
git fetch
git rebase
```
#### 4. Make the mkiocccentry toolkit
```sh
make clobber all
```
#### 5. Run the mkiocccentry tool to form your entry tarball
```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 [FAQ 2.1](#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.
If `mkiocccentry` tool indicates that there is a problem with your entry,
especially if it identifies a [rule 2](next/rules.html#2) 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 an explain your reason
for doing so in your `remarks.md` file.
#### 6. Upload your entry to the IOCCC submit server
The **IOCCC submit server** is still being written.
<!--XXX--> As such, we do not yet have instructions
on how upload your entry to the **IOCCC submit server**. Once
**IOCCC submit server** is ready, we will update this section
with the proper instructions. Watch the [IOCCC news](news.html)
for an annoucement of the availability of the **IOCCC submit server**.
index.html
+4 -10
View File
@@ -395,6 +395,7 @@ then consider making pull requests against the <a href="https://github.com/ioccc
<ul> <ul>
<li><strong><a href="years.html">Winning Entries</a></strong></li> <li><strong><a href="years.html">Winning Entries</a></strong></li>
<li><strong><a href="authors.html">People who have won</a></strong></li> <li><strong><a href="authors.html">People who have won</a></strong></li>
<li>Other parts of the IOCCC menu</li>
</ul> </ul>
<p>If you see this icon <a href="nojs-menu.html"> <img src="png/hamburger-icon-open.png" <p>If you see this icon <a href="nojs-menu.html"> <img src="png/hamburger-icon-open.png"
alt="hambuger-style menu icon" alt="hambuger-style menu icon"
@@ -419,16 +420,9 @@ then consider making pull requests against the <a href="https://github.com/ioccc
<li>To illustrate some of the subtleties of the C language.</li> <li>To illustrate some of the subtleties of the C language.</li>
<li>To provide a safe forum for poor C code. :-)</li> <li>To provide a safe forum for poor C code. :-)</li>
</ul> </ul>
<h1 id="the-ioccc-is-currently-closed.">The IOCCC is currently <strong>CLOSED</strong>.</h1> <h1 id="entering-the-contest">Entering the Contest</h1>
<p>Right now, you <strong>CANNOT register</strong> as a contestant with the IOCCC,<BR> <p>View the <a href="status.html">current status of the IOCCC</a> to see of the IOCCC is open for submissions.</p>
nor can you send us a submission, because the <strong>IOCCC</strong> is yet <strong>NOT open</strong>. <p>See <a href="faq.html#submit">FAQ 0.0: How may I submit to the IOCCC?</a> for more information.</p>
<BR>
You may wish to follow <a href="https://fosstodon.org/@ioccc">IOCCC on Mastodon</a> as we announce
the start of an new IOCCC there.
<BR>
Speaking of IOCCC news, you may wish to visit <a href="news.html#news">IOCCC news</a> for information on the next <strong>IOCCC</strong>.
<BR>
You may also check on the <a href="status.json">status.json</a> for the current status of the <strong>IOCCC</strong>.</p>
<!-- <!--
Copyright © 1984-2024 by Landon Curt Noll. All Rights Reserved. Copyright © 1984-2024 by Landon Curt Noll. All Rights Reserved.
index.md
+5 -10
View File
@@ -21,6 +21,7 @@ Explore, under the **Entries** in the _topbar_ menu:
* **[Winning Entries](years.html)** * **[Winning Entries](years.html)**
* **[People who have won](authors.html)** * **[People who have won](authors.html)**
* Other parts of the IOCCC menu
If you see this icon <a href="nojs-menu.html"> <img src="png/hamburger-icon-open.png" If you see this icon <a href="nojs-menu.html"> <img src="png/hamburger-icon-open.png"
alt="hambuger-style menu icon" alt="hambuger-style menu icon"
@@ -53,17 +54,11 @@ The goals of the IOCCC:
* To provide a safe forum for poor C code. :-) * To provide a safe forum for poor C code. :-)
# The IOCCC is currently **CLOSED**. # Entering the Contest
Right now, you **CANNOT register** as a contestant with the IOCCC,<BR> View the [current status of the IOCCC](status.html) to see of the IOCCC is open for submissions.
nor can you send us a submission, because the **IOCCC** is yet **NOT open**.
<BR> See [FAQ 0.0: How may I submit to the IOCCC?](faq.html#submit) for more information.
You may wish to follow [IOCCC on Mastodon](https://fosstodon.org/@ioccc) as we announce
the start of an new IOCCC there.
<BR>
Speaking of IOCCC news, you may wish to visit [IOCCC news](news.html#news) for information on the next **IOCCC**.
<BR>
You may also check on the [status.json](status.json) for the current status of the **IOCCC**.
<!-- <!--