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

Reorganise menus

Browse Source 
The sections have been modified a fair amount. The Entries menu has been
extended to have: Fixing entries, Updating author info, Thanks for the
help. The first two were moved from FAQ and the last one from About.
The rationale for these, in order: entries and authors have to do with
entries and most of the help involves entries. It also has to do with
website but in 'about' it does not seem the right place, unless maybe it
is renamed to 'Credits' or something (I am not suggesting this one way
or the other). This one is debatable but that was the rationale.

The Status menu has been extended to have: Markdown guidelines and
Security policy. The rationale is that the markdown guidelines are part
of contest guidelines and the security policy is about the status of the
entries and how if there are any security problems they will not be
addressed (instead of about the IOCCC).

The FAQ was extended to have: Compiling entries, Running entries, How to
help. The reason to not have compiling and running entries under Entries
is because this is 'how to' and also the menu was too long. How to help
seems like a good idea under FAQ too (was in About).

About was extended to have the new 'about.html' page (from about.md).
This is a rare case where a new file is useful as it fits under 'About'.
The menu now is: Home page, About the IOCCC, The Judges, Contact us. I
was pondering the 'About [the IOCCC]' at the top and also naming it
'About us' but it seemed like a link to index.html was necessary and as
for 'about us' it seemed less clear as to whether it was about the
judges or the contest itself. The FAQ has been updated slightly for
this.

After further inspection the bin/index.html and the inc/index.html links
were removed from the about section.

With these changes, renaming an item or slight reordering
notwithstanding, I believe that #2006 is probably in good shape.
This commit is contained in:
Cody Boone Ferguson committed 2024-10-25 11:23:21 -07:00
1 parent 75c89bd544
commit af5482825c
421 files changed
+36559 -29682
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

next/guidelines.html
+112 -76
View File
@@ -62,19 +62,19 @@
<div class="sub-item">
<div class="outfit-font">
<a href="../years.html" class="sub-item-link">
Winning Entries
Winning entries
</a>
</div>
<div class="outfit-font">
<a href="../authors.html" class="sub-item-link">
Winning Authors
Winning authors
</a>
</div>
<div class="outfit-font">
<a href="../location.html" class="sub-item-link">
Location of winning authors
Location of authors
</a>
</div>
@@ -83,6 +83,24 @@
Bugs and (mis)features
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#fix_an_entry" class="sub-item-link">
Fixing entries
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#fix_author" class="sub-item-link">
Updating author info
</a>
</div>
<div class="outfit-font">
<a href="../thanks-for-help.html" class="sub-item-link">
Thanks for the help
</a>
</div>
</div>
</div>
@@ -94,7 +112,7 @@
<div class="sub-item">
<div class="outfit-font">
<a href="../news.html" class="sub-item-link">
IOCCC News
News
</a>
</div>
@@ -106,15 +124,22 @@
<div class="outfit-font">
<a href="../next/index.html" class="sub-item-link">
Rules and Guidelines
Rules and guidelines
</a>
</div>
<div class="outfit-font">
<a href="../markdown.html" class="sub-item-link">
IOCCC Markdown Guidelines
Markdown guidelines
</a>
</div>
<div class="outfit-font">
<a href="../SECURITY.html" class="sub-item-link">
Security policy
</a>
</div>
</div>
</div>
@@ -126,33 +151,34 @@
<div class="sub-item">
<div class="outfit-font">
<a href="../faq.html" class="sub-item-link">
FAQ
Frequently Asked Questions
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#submit" class="sub-item-link">
How to enter the IOCCC
How to enter
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#fix_an_entry" class="sub-item-link">
Fixing IOCCC entries
<a href="../faq.html#compiling" class="sub-item-link">
Compiling entries
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#fix_website" class="sub-item-link">
Fixing the website
<a href="../faq.html#running_entries" class="sub-item-link">
Running entries
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#fix_author" class="sub-item-link">
Updating author info
<a href="../faq.html#help" class="sub-item-link">
How to help
</a>
</div>
</div>
</div>
@@ -164,43 +190,25 @@
<div class="sub-item">
<div class="outfit-font">
<a href="../index.html" class="sub-item-link">
IOCCC Home
Home page
</a>
</div>
<div class="outfit-font">
<a href="../about.html" class="sub-item-link">
About the IOCCC
</a>
</div>
<div class="outfit-font">
<a href="../judges.html" class="sub-item-link">
The IOCCC Judges
The Judges
</a>
</div>
<div class="outfit-font">
<a href="../contact.html" class="sub-item-link">
Contacting the IOCCC
</a>
</div>
<div class="outfit-font">
<a href="../SECURITY.html" class="sub-item-link">
IOCCC Security Policy
</a>
</div>
<div class="outfit-font">
<a href="../thanks-for-help.html" class="sub-item-link">
Thanks for the help
</a>
</div>
<div class="outfit-font">
<a href="../bin/index.html" class="sub-item-link">
Website scripts
</a>
</div>
<div class="outfit-font">
<a href="../inc/index.html" class="sub-item-link">
Script include files
Contact us
</a>
</div>
</div>
@@ -242,11 +250,11 @@
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="../years.html">
Winning Entries
Winning entries
</a>
<a class="mobile-submenu-item" href="../authors.html">
Authors of winning IOCCC entries
Winning authors
</a>
<a class="mobile-submenu-item" href="../location.html">
@@ -257,6 +265,17 @@
Bugs and (mis)features
</a>
<a class="mobile-submenu-item" href="../faq.html#fix_an_entry">
Fixing entries
</a>
<a class="mobile-submenu-item" href="../faq.html#fix_author">
Updating author info
</a>
<a class="mobile-submenu-item" href="../thanks-for-help.html">
Thanks for the help
</a>
</div>
</div>
@@ -267,22 +286,25 @@
</div>
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="../news.html">
News
</a>
<a class="mobile-submenu-item" href="../status.html">
Contest status
</a>
<a class="mobile-submenu-item" href="../next/index.html">
Rules and Guidelines
</a>
<a class="mobile-submenu-item" href="../news.html">
IOCCC News
Rules and guidelines
</a>
<a class="mobile-submenu-item" href="../markdown.html">
IOCCC Markdown Guidelines
Markdown guidelines
</a>
<a class="mobile-submenu-item" href="../SECURITY.html">
Security policy
</a>
</div>
</div>
@@ -297,19 +319,19 @@
</a>
<a class="mobile-submenu-item" href="../faq.html#submit">
How to enter the IOCCC
How to enter
</a>
<a class="mobile-submenu-item" href="../faq.html#fix_an_entry">
Fixing IOCCC entries
<a class="mobile-submenu-item" href="../faq.html#compiling">
Compiling entries
</a>
<a class="mobile-submenu-item" href="../faq.html#fix_website">
Fixing the website
<a class="mobile-submenu-item" href="../faq.html#running_entries">
Running entries
</a>
<a class="mobile-submenu-item" href="../faq.html#fix_author">
Fixing author info
<a class="mobile-submenu-item" href="../faq.html#help">
How to help
</a>
</div>
@@ -322,31 +344,22 @@
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="../index.html">
IOCCC Home
Home page
</a>
<a class="mobile-submenu-item" href="../about.html">
About the IOCCC
</a>
<a class="mobile-submenu-item" href="../judges.html">
The IOCCC Judges
The Judges
</a>
<a class="mobile-submenu-item" href="../contact.html">
Contacting the IOCCC
</a>
<a class="mobile-submenu-item" href="../thanks-for-help.html">
Thanks for the help
</a>
<a class="mobile-submenu-item" href="../bin/index.html">
Website scripts
</a>
<a class="mobile-submenu-item" href="../inc/index.html">
Script include files
Contact us
</a>
</div>
</div>
</div>
</div>
</div>
@@ -445,13 +458,15 @@ Copyright © 2024 Leonid A. Broukhis and Landon Curt Noll.
granted provided this this copyright and notice are included in its entirety
and remains unaltered. All other uses must receive prior permission in
writing by <a href="../contact.html">contacting the judges</a>.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="guidelines_version">
<h2 id="ioccc-guidelines-version">IOCCC Guidelines version</h2>
</div>
<p class="leftbar">
These <a href="guidelines.html">IOCCC guidelines</a> are version <strong>28.18 2024-10-21</strong>.
These <a href="guidelines.html">IOCCC guidelines</a> are version <strong>28.19 2024-10-25</strong>.
</p>
<p><strong>IMPORTANT</strong>: Be <strong>SURE</strong> to read the <a href="rules.html">IOCCC rules</a>.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="change_marks">
<h3 id="change-marks">Change marks</h3>
</div>
@@ -462,6 +477,7 @@ previous IOCCC</strong>.
<p>Most lines (we sometimes make mistakes) that were modified since the previous
IOCCC start with a solid 4 pixel black left border (or, in the case of a code
block or blockquote, just a vertical bar).</p>
<p>Jump to: <a href="#">top</a></p>
<div id="about_guidelines">
<h1 id="about-this-file">ABOUT THIS FILE:</h1>
</div>
@@ -477,6 +493,7 @@ guidelines</a>.</p>
<p><strong>You should read the current <a href="rules.html">IOCCC rules</a>, prior to submitting
entries</strong>. The <a href="rules.html">rules</a> are typically published along with the <a href="guidelines.html">IOCCC
guidelines</a>..</p>
<p>Jump to: <a href="#">top</a></p>
<div id="new">
<h1 id="whats-new-this-ioccc">WHAT’S NEW THIS IOCCC</h1>
</div>
@@ -542,6 +559,7 @@ it</strong>.
The IOCCC submission URL, <a href="../status.html#open">when the IOCCC is open</a>, is
<a href="https://submit.ioccc.org/">submit.ioccc.org</a>.
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="hints">
<div id="suggestions">
<h1 id="hints-and-suggestions">HINTS AND SUGGESTIONS:</h1>
@@ -676,6 +694,7 @@ The <a href="rules.html#rule2a">Rule 2a</a> size was changed from
value similar to the <a href="../faq.html#size_rule2001-2012">2001-2012</a> and
<a href="../faq.html#size_rule2013-2020">2013-2020</a> IOCCC eras.
</p>
<p>Jump to: <a href="#">top</a></p>
<h2 id="mkiocccentry"><code>mkiocccentry</code></h2>
<p class="leftbar">
<a href="rules.html#rule17">Rule 17</a> (the <code>mkiocccentry(1)</code> rule) states that
@@ -730,6 +749,7 @@ NOT recommend these options.
In many places it will prompt you to verify what you input, allowing you to
correct details as you go along.
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="mkiocccentry-synopsis">
<h2 id="mkiocccentry1-synopsis"><code>mkiocccentry(1)</code> synopsis</h2>
</div>
@@ -753,12 +773,14 @@ for how to use this tool in more detail.
<p class="leftbar">
Below are the tools that <code>mkiocccentry(1)</code> will run.
</p>
<p>Jump to: <a href="#">top</a></p>
<h2 id="iocccsize"><code>iocccsize</code></h2>
<p class="leftbar">
<code>mkiocccentry(1)</code> will use code from <code>iocccsize(1)</code> which
detects a number of issues that you may ignore, if you wish, as described above.
As we already discussed how to invoke this we will not include it here again.
</p>
<p>Jump to: <a href="#">top</a></p>
<h2 id="chkentry"><code>chkentry</code></h2>
<p class="leftbar">
<code>mkiocccentry(1)</code> will write two JSON files: <code>.auth.json</code> and
@@ -790,6 +812,7 @@ and the
FAQ on “<a href="../faq.html#info_json">.info.json</a>”
for much more information on these files.
</p>
<p>Jump to: <a href="#">top</a></p>
<h2 id="txzchk"><code>txzchk</code></h2>
<p class="leftbar">
<code>txzchk(1)</code> performs a wide number of sanity checks on the xz
@@ -829,6 +852,7 @@ manually package your submission tarball, you could still be violating <a href="
See also the
FAQ on “<a href="../faq.html#txzchk">txzchk</a>”.
</p>
<p>Jump to: <a href="#">top</a></p>
<h2 id="fnamchk"><code>fnamchk</code></h2>
<p class="leftbar">
A tool that <a href="#txzchk">txzchk</a> runs is <code>fnamchk</code>. This is an important part of
@@ -998,6 +1022,7 @@ use the <code>COTHER</code> Makefile variable. For example:
<strong>NOTE</strong>: <strong>We only recommend using “<em>magic</em>” flags if <em>BOTH</em> <code>gcc</code>
<em>and</em> <code>clang</code></strong> support it.
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="likes">
<div id="dislikes">
<h1 id="our-likes-and-dislikes">OUR LIKES AND DISLIKES:</h1>
@@ -1541,10 +1566,11 @@ aware that some people may use tab stop that is different than the common 8
character tab stop.
</p>
<p class="leftbar">
<strong>PLEASE</strong> observe our <a href="../markdown.html">IOCCC Markdown Guidelines</a>
<strong>PLEASE</strong> observe our <a href="../markdown.html">IOCCC markdown guidelines</a>
when forming your submission’s <code>remarks.md</code> file. And if your submission
contains additional markdown files, please follow those same guidelines. See
also <a href="rules.html#rule19">Rule 19</a>.
contains additional markdown files, please follow those same guidelines for
those files. See also <a href="rules.html#rule19">Rule 19</a> and our
FAQ on “<a href="../faq.html#markdown">markdown</a>”.
</p>
<p class="leftbar">
We <strong>LIKE</strong> reading <code>remarks.md</code> files, especially if they contain
@@ -1555,6 +1581,7 @@ is a <strong>hint</strong>. :-)
We <strong>RECOMMEND</strong> you put a reasonable amount effort into the content of the
<code>remarks.md</code> file: it is a required for a reason. :-)
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="rules_abuse">
<div id="abusing_rules">
<h1 id="abusing-the-rules">ABUSING THE RULES:</h1>
@@ -1613,6 +1640,7 @@ sometimes conflicting specifications and requirements from marketing, sales,
product management an even from customers themselves on a all too regular basis.
This is one of the reasons why the <a href="rules.html">IOCCC rules</a> and
<a href="guidelines.html">IOCCC guidelines</a> are written in obfuscated form.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="judging">
<h1 id="judging-process">JUDGING PROCESS:</h1>
</div>
@@ -1667,6 +1695,7 @@ account</a>.
<strong>Make sure you reload the feed</strong> every so often <strong>because unless you
are mentioned you will NOT get a push notification!</strong>
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="rounds">
<h2 id="judging-rounds">JUDGING ROUNDS:</h2>
</div>
@@ -1675,6 +1704,7 @@ the collection of entries are divided into two roughly equal piles;
the pile that advances on to the next round, and the pile that does
not. We also re-examine the entries that were eliminated in the
previous round. Thus, a submission gets at least two readings.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="readings">
<h2 id="judging-readings">JUDGING READINGS:</h2>
</div>
@@ -1779,6 +1809,7 @@ a submission simply far exceeds any of the other entries. More often, the
<p>In years past, we renamed the winning submission from <code>prog.c</code> to a
name related to the author(s)’ names. This is no longer done.
Winning source is called <code>prog.c</code>. A compiled binary is called <code>prog</code>.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="announcements">
<h1 id="announcement-of-winners">ANNOUNCEMENT OF WINNERS:</h1>
</div>
@@ -1792,6 +1823,7 @@ We recommend that you follow us on mastodon but <strong>please make sure to
refresh the feed</strong> every so often (if not more often) because unless you are
mentioned or someone boosts your post you will not get a push notification.
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="winners">
<h2 id="how-the-new-ioccc-winners-will-be-announced">How the new IOCCC winners will be announced</h2>
</div>
@@ -1819,6 +1851,7 @@ The <a href="../judges.html">IOCCC judges</a> will commit the winning source to
<p class="leftbar">
The <a href="../news.html">IOCCC news</a> will also contain an announcement of the winners.
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="mastodon">
<h2 id="an-important-update-to-how-winners-are-announced">An important update to how winners are announced</h2>
</div>
@@ -1831,6 +1864,7 @@ website</a>.
<p class="leftbar">
In addition a note is posted to the <a href="https://fosstodon.org/@ioccc">IOCCC Mastodon account</a>.
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="entries">
<h2 id="back-to-announcement-of-winners">Back to announcement of winners</h2>
</div>
@@ -1844,6 +1878,7 @@ world. Winners have appeared in books (‘<code>The New Hacker's Dictionary</cod
‘<code>Obfuscated C and Other Mysteries</code>’, ‘<code>Pointers On C</code>’, others) and on t-shirts.
More than one winner has been turned into a tattoo!</p>
<p>Last, but not least, <a href="../authors.html">winners</a> receive international fame and flames! :-)</p>
<p>Jump to: <a href="#">top</a></p>
<div id="more-information">
<div id="information">
<h1 id="for-more-information">FOR MORE INFORMATION:</h1>
@@ -1874,6 +1909,7 @@ notification so you should make sure to check the page.
<p class="leftbar">
Check out the <a href="https://www.ioccc.org/index.html">Official IOCCC website</a> in general.
</p>
<p>Jump to: <a href="#">top</a></p>
<p>Leonid A. Broukhis<br>
chongo (Landon Curt Noll) /\cc/\</p>
<hr style="width:10%;text-align:left;margin-left:0">