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

improve word flow around FAQ references

Browse Source
This commit is contained in:
Landon Curt Noll committed 2024-07-21 16:17:20 -07:00
1 parent f7e7610370
commit 89e66b96c5
41 files changed
+289 -213
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+29 -26
View File
@@ -545,7 +545,7 @@ to our submission portal.</p>
<li><p>Makefile</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
<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>
@@ -585,7 +585,7 @@ winners based on the same theme.</p>
frequently submitted theme, be sure that it is obfuscated in several
new and novel ways.</p>
<p><strong>IMPORTANT HINT</strong>: Be sure to <strong>clearly explain</strong> near the beginning
of your <code>remarks.md</code> file, see
of your <code>remarks.md</code> file, see the
FAQ on “<a href="#remarks_md">remarks.md</a>”,
<strong>why you are submitting a entry based on a frequently
submitted theme</strong> and <strong>how compares with previous IOCCC winners</strong>
@@ -665,7 +665,7 @@ previous IOCCC entries make it more challenging to be successful.</p>
state something along the lines of:</p>
<pre><code> We tend to dislike programs that: are similar to previous winning entries.</code></pre>
<p><strong>FAIR WARNING</strong>: Be sure to <strong>clearly explain</strong> near the beginning
of your <code>remarks.md</code> file, see
of your <code>remarks.md</code> file, see the
FAQ on “<a href="#remarks_md">remarks.md</a>”,
<strong>why you are submitting a entry based on a frequently
submitted theme</strong> and <strong>how compares with previous IOCCC winners</strong>
@@ -792,7 +792,7 @@ with your submission. If the <a href="judges.html">IOCCC judges</a> truly need m
information, they will ask (either in public or suggest a private conversation).</p>
<p>Again, <strong>please</strong> don’t hesitate to ask: Your question may be something that
others are wondering about as well!</p>
<p>See also
<p>See also the
FAQ on “<a href="#feedback">rules, guidelines, tools feedback</a>”.</p>
<div id="faq0_7">
<div id="markdown">
@@ -874,7 +874,7 @@ for a list of valid codes.</li>
<li><p><code>mastodon</code> (null or double quoted string)</p>
<ul>
<li>The Mastodon handle of this author in the form of <code>@user@domain</code>, or
<code>null</code> if not provided. See
<code>null</code> if not provided. See the
FAQ on “<a href="#try_mastodon">Mastodon</a>”
for more information.</li>
</ul></li>
@@ -912,9 +912,9 @@ by this author.</li>
<p><strong>NOTE:</strong> if you have won before, we <strong>ENCOURAGE</strong> you to use the same handle of
your previous winning entries, to help in organising the
<a href="authors.html">authors.html</a> page and the author JSON file.
See
See the
FAQ on “<a href="#author_handle_faq">author handle</a>”
and
and the
FAQ on “<a href="#author_json">author_handle.json</a>”
for more information.</p></li>
<li><p><code>author_number</code> (number)</p>
@@ -1047,7 +1047,7 @@ array your submission <strong>will be</strong> invalid.</p></li>
<li><p><code>formed_timestamp</code> (number)</p>
<ul>
<li>Seconds since epoch when <code>.auth.json was formed (see</code>gettimeofday(2)`).
See also
See also the
FAQ on “<a href="#info_json">.info.json</a>”
for more inforation.</li>
</ul>
@@ -1118,7 +1118,7 @@ the <strong>mandatory</strong> <code>remarks.md</code> file,
and the <strong>mandatory</strong> C source file.
See the
FAQ on “<a href="#auth_json">.auth.json</a>”
and
and the
FAQ on “<a href="#remarks_md">remarks.md</a>”
for more inforation.</p>
<ul>
@@ -2031,7 +2031,7 @@ in question to see if the problem is known, and if a fix is wanted,
consider trying to port the code to a 64-bit system and submitting
a pull request with that change. Pull requests that fix such code
while trying to minimize the impact of any changes and preserving
the spirit of the original code are very welcome! Please see
the spirit of the original code are very welcome! Please see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”
for details. See also the
FAQ on “<a href="#pull_request">GitHub pull request</a>”
@@ -2048,7 +2048,7 @@ others will be looked at, when found.</p>
with an entry. Should you manage to port the entry, and assuming your changes
also attempt to preserve the original intent of the IOCCC entry, we would
encourage you to submit a pull request with your ported code.
Please see
Please see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”
for details.</p>
<div id="faq3_4">
@@ -2068,7 +2068,7 @@ other things that have to be done plus remembering to do it.</p>
<p>See if the problem is mentioned in <a href="bugs.html">bugs.html</a>. If you have a change
that fixes the problem (even if it just a change to the <code>Makefile</code>) that doesn’t
negatively impact the entry too much, consider submitting that change in the
form of a pull request. Please see
form of a pull request. Please see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”.
See also the
FAQ on “<a href="#pull_request">GitHub pull request</a>”
@@ -2155,7 +2155,7 @@ for more information.</p>
provide <strong>alternate code</strong> that works for Wayland. We will happily credit you in
the <a href="thanks-for-help.html">thanks-for-help.html</a> file.</p>
<h4 id="red-hat-based-linux">Red Hat based Linux</h4>
<p>First, see
<p>First, see the
FAQ on “<a href="#X11_general">general X11</a>”.</p>
<p>Install Xorg and related packages:</p>
<pre><code> sudo dnf install --skip-broken --best --exclude xorgxrdp --exclude xorgxrdp-glamor &#39;*xorg*&#39; &#39;libx*&#39; &#39;libX*&#39; &#39;fontconfig*&#39;</code></pre>
@@ -2490,7 +2490,7 @@ that you may wish to try.</p>
entry. If so, you are invited to try and fix the IOCCC entry and
submit that fix by way of a <a href="https://github.com/ioccc-src/winner/pulls">GitHub pull
request</a>.
Please see
Please see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”
for how to submit a fix to an IOCCC entry.</p>
<div id="faq3_14">
@@ -2629,7 +2629,7 @@ for downloading, installing and using ImageMagick.</p>
</div>
</div>
<p>This depends on your operating system for which we describe a couple below.</p>
<p>In general OpenGL needs X11 to be installed and the X Window Server to be running. See
<p>In general OpenGL needs X11 to be installed and the X Window Server to be running. See the
FAQ on “<a href="#X11">X11</a>”
for general information about X11.</p>
<p>Once X11 is install and the X Window Server is running, one needs to compile
@@ -2939,7 +2939,7 @@ original code is in <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/m
some cases, such as <code>1984/mullender</code>, the original code is the same as the code
as no changes were made (there is an alt version for systems that are not
VAX-11/PDP-11, however).</p>
<p>See also
<p>See also the
FAQ on “<a href="#what_changed">entry source code changes</a>”</p>
<div id="faq4_4">
<h3 id="faq-4.4-what-is-the-meaning-of-the-file-ending-in-.orig.c-in-ioccc-entries">FAQ 4.4: What is the meaning of the file ending in .orig.c in IOCCC entries?</h3>
@@ -3003,10 +3003,13 @@ other times something else.</p>
<p>Like with files being renamed, there are multiple reasons files were added or
removed. The addition of the <code>try.sh</code> and <code>try.alt.sh</code> scripts is the most
significant example of files being added. These scripts, as the
FAQ on “<a href="#try">try.sh and try.alt.sh</a>”,
<code>try.sh</code> sometimes the <code>try.alt.sh</code> scripts
help demonstrate entries by automating commands, sometimes many
commands and not always simple commands, that one would previously have to run
manually (there are other benefits as well).</p>
<p>See the
FAQ on “<a href="#try">try.sh and try.alt.sh</a>”
for more details.</p>
<p>Alternate code, sometimes provided by the author, sometimes provided by the
judges and sometimes other people, was added to some entries as well.</p>
<p>In the case that a link might end up with a 404 the files, if possible, were
@@ -3028,7 +3031,7 @@ ways.</p>
<p>The <a href="bugs.html">known bugs</a> file, order by IOCCC years, contains a
list of known bugs &amp; (mis)features. If you are looking for an IOCCC entry
to try and fix, this file is a good place to start.</p>
<p>See
<p>See the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”
for information on how to submit a fix to
an IOCCC entry. Before you consider trying to fix an IOCCC winning entry,
@@ -3054,7 +3057,7 @@ course if the entry does not work we’ll certainly be more inclined to accept t
fix. If it is accepted we’ll be happy to credit you in the
<a href="thanks-for-help.html">thanks</a> file. If you’re a previous author of a winning IOCCC entry we will happily
link to your entries; if you’re not we can link to your website if you wish.</p>
<p>Please see
<p>Please see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”
for information on how to submit a fix to an
IOCCC entry. See also the
@@ -3091,7 +3094,7 @@ IOCCC winning entries are presented!</p>
<a href="https://github.com/ioccc-src/winner/pulls">GitHub pull request</a>
against the <a href="https://github.com/ioccc-src/winner/branches">master branch</a>
of the <a href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a>.</p>
<p>Please see
<p>Please see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”.
See also the
FAQ on “<a href="#pull_request">GitHub pull request</a>”
@@ -3104,15 +3107,15 @@ have the final say in the matter.</p>
</div>
</div>
<p>If you discover a problem with the IOCCC website that is related
to a particular IOCCC entry, please see
to a particular IOCCC entry, please see the
FAQ on “<a href="#report_bug">report entry bug</a>”
for information about reporting a bug in an IOCCC entry, and see
for information about reporting a bug in an IOCCC entry, and see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”
for information on how to submit a fix to an IOCCC entry.</p>
<p>If you discover a problem with the IOCCC website (such as a broken link, which
may or may not be specific to a particular IOCCC entry) that is <strong>not related
to a particular IOCCC entry</strong>, the best way you can help is to submit a fix to
the IOCCC website. See
the IOCCC website. See the
FAQ on “<a href="#fix_web_site">fixing the website</a>”
for information on submitting fixes
to the IOCCC website.</p>
@@ -3128,14 +3131,14 @@ to <a href="https://github.com/ioccc-src/winner/issues/new">open a new IOCCC iss
</div>
</div>
<p>For IOCCC website problems that relate to a particular IOCCC entry, please
see
see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”
for information on how submit a fix to an IOCCC entry.</p>
<p>You may open a <a href="https://github.com/ioccc-src/winner/pulls">GitHub pull request</a>
against the <a href="https://github.com/ioccc-src/winner/branches">master branch</a>
of the <a href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a>
to submit a fix.</p>
<p>Please see
<p>Please see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”.
See also the
FAQ on “<a href="#pull_request">GitHub pull request</a>”
@@ -3163,7 +3166,7 @@ AND then run <code>make www</code> from the top level directory in your IOCCC pu
request. There are quicker ways but to be sure you get
everything built you should do this. If you modified a markdown and you do not
see the same file as a html file then you did not complete the fix.</p>
<p>Please see
<p>Please see the
FAQ on “<a href="#fix_an_entry">fixing an entry</a>”.</p>
<p>See also the
FAQ on “<a href="#pull_request">GitHub pull request</a>”