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

improve and add FAQ about rules, guidelines, tools

Browse Source
This commit is contained in:
Landon Curt Noll committed 2024-06-30 15:50:42 -07:00
1 parent dc1e651eea
commit 91adb55e07
3 files changed
+109 -13
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Makefile
+2 -2
View File
@@ -516,9 +516,9 @@ guidelines: ${GEN_TOP_HTML} next/guidelines.md
faq: ${GEN_TOP_HTML} faq.md
@echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-='
@echo "Wait, you have questions? Uh oh!"
@echo "You have a question?"
@${GEN_TOP_HTML} faq
@echo "Well, okay then!"
@echo "Perhaps the FAQ might help."
@echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-='
faq.html
+47 -5
View File
@@ -391,7 +391,8 @@
<li><a href="#faq0_3">0.3 - May I use a different source or compiled filename than prog.c or prog?</a></li>
<li><a href="#faq0_4">0.4 - What platform should I assume for my entry?</a></li>
<li><a href="#faq0_5">0.5 - How may I comment or make a suggestion on IOCCC rules, guidelines and tools?</a></li>
<li><a href="#faq0_6">0.6 - What are the IOCCC best practices for using markdown?</a></li>
<li><a href="#faq0_6">0.6 - What is the best way to ask a question about the IOCCC rules, guideline and tools?</a></li>
<li><a href="#faq0_7">0.7 - What are the IOCCC best practices for using markdown?</a></li>
</ul>
<h2 id="section-1---history-of-the-ioccc">Section 1 - <a href="#faq1">History of the IOCCC</a></h2>
<ul>
@@ -728,12 +729,53 @@ If there is an on-going discussion that seems relevant to what you
have to say, consider adding comments to that particular discussion.
Otherwise consider opening a <a href="https://github.com/ioccc-src/mkiocccentry/discussions/new/choose">new mkiocccentry
discussion</a>.</p>
<p>As a very last resort and/or if you feel the need to engage in a private
discussion with the <a href="judges.html">IOCCC judges</a>, then see
<a href="contact.html">How to contact the IOCCC</a>.</p>
<div id="faq0_6">
<div id="question">
<h3 id="faq-0.6-what-is-the-best-way-to-ask-a-question-about-the-ioccc-rules-guideline-and-tools">FAQ 0.6: What is the best way to ask a question about the IOCCC rules, guideline and tools?</h3>
</div>
</div>
<p>We realise that the <a href="next/rules.html">IOCCC rules</a>, <a href="next/guidelines.html">IOCCC guidelines</a>
and the <a href="https://github.com/ioccc-src/mkiocccentry">IOCCC mkiocccentry tools</a>
can be confusing or even seem overwhelming to some people.</p>
<p>The <a href="judges.html">IOCCC judges</a> to welcomes questions about the IOCCC
and will be <strong>happy to help</strong>.</p>
<p>Chances are, if you have a question, there are a number of other people who
have similar questions. So we recommend first view the
<a href="https://github.com/ioccc-src/winner/discussions">GitHub discussions for this repo</a>
so see if someone else asked already. Feel free to join in on such a discussion,
even if to just say:</p>
<blockquote>
<p>I have this question too.</p>
</blockquote>
<p>Feel free to provide additional feedback in the existing discussion as needed.</p>
<p><strong>BTW</strong>: If your question just about the
<a href="https://github.com/ioccc-src/mkiocccentry">IOCCC mkiocccentry tools</a>, please
view the <a href="https://github.com/ioccc-src/mkiocccentry/discussions">mkiocccentry repo discussions</a>
instead.</p>
<p>If you do not find an suitable open discussion, please consider opening a
<a href="https://github.com/ioccc-src/winner/discussions/new/choose">new IOCCC repo discussion</a> with
your question. Doing this may be of help to others with a question similar to yours.</p>
<p><strong>BTW</strong>: If your question just about the
<a href="https://github.com/ioccc-src/mkiocccentry/discussions">IOCCC mkiocccentry tools</a>, please
and suitable open discussion over there, then please consider opening a
<a href="https://github.com/ioccc-src/mkiocccentry/discussions/new/choose">new mkiocccentry discussion</a>
over there.</p>
<p>If you do not feel, for some reason, comfortable asking your question in public
(although we hope you consider asking it in public for the benefit of others),
then use the <a href="contact.html">How to contact the IOCCC</a> information to ask
a private question.</p>
<p><strong>IMPORTANT</strong>: When you ask your question (in public or as a private question)
<strong>PLEASE</strong> try to <strong>NOT</strong> spoil the surprise of your pending submission.
Try to ask for question in a more generic way as this will help others
with a similar question and this will not <strong>give away</strong> what you might be doing
with your submission. If the <a href="judges.html">IOCCC judges</a> truly need more
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 [FAQ about making suggestions)(#faq0_5).</p>
<div id="faq0_7">
<div id="markdown">
<h3 id="faq-0.6---what-are-the-ioccc-best-practices-for-using-markdown">FAQ 0.6: - What are the IOCCC best practices for using markdown?</h3>
<h3 id="faq-0.7---what-are-the-ioccc-best-practices-for-using-markdown">FAQ 0.7: - What are the IOCCC best practices for using markdown?</h3>
</div>
</div>
<p>The IOCCC makes extensive use of <a href="https://daringfireball.net/projects/markdown/">markdown</a>.
faq.md
+60 -6
View File
@@ -8,7 +8,8 @@
- [0.3 - May I use a different source or compiled filename than prog.c or prog?](#faq0_3)
- [0.4 - What platform should I assume for my entry?](#faq0_4)
- [0.5 - How may I comment or make a suggestion on IOCCC rules, guidelines and tools?](#faq0_5)
- [0.6 - What are the IOCCC best practices for using markdown?](#faq0_6)
- [0.6 - What is the best way to ask a question about the IOCCC rules, guideline and tools?](#faq0_6)
- [0.7 - What are the IOCCC best practices for using markdown?](#faq0_7)
## Section 1 - [History of the IOCCC](#faq1)
@@ -457,14 +458,66 @@ have to say, consider adding comments to that particular discussion.
Otherwise consider opening a [new mkiocccentry
discussion](https://github.com/ioccc-src/mkiocccentry/discussions/new/choose).
As a very last resort and/or if you feel the need to engage in a private
discussion with the [IOCCC judges](judges.html), then see
[How to contact the IOCCC](contact.html).
<div id="faq0_6">
<div id="question">
### FAQ 0.6: What is the best way to ask a question about the IOCCC rules, guideline and tools?
</div>
</div>
We realise that the [IOCCC rules](next/rules.html), [IOCCC guidelines](next/guidelines.html)
and the [IOCCC mkiocccentry tools](https://github.com/ioccc-src/mkiocccentry)
can be confusing or even seem overwhelming to some people.
The [IOCCC judges](judges.html) to welcomes questions about the IOCCC
and will be **happy to help**.
Chances are, if you have a question, there are a number of other people who
have similar questions. So we recommend first view the
[GitHub discussions for this repo](https://github.com/ioccc-src/winner/discussions)
so see if someone else asked already. Feel free to join in on such a discussion,
even if to just say:
> I have this question too.
Feel free to provide additional feedback in the existing discussion as needed.
**BTW**: If your question just about the
[IOCCC mkiocccentry tools](https://github.com/ioccc-src/mkiocccentry), please
view the [mkiocccentry repo discussions](https://github.com/ioccc-src/mkiocccentry/discussions)
instead.
If you do not find an suitable open discussion, please consider opening a
[new IOCCC repo discussion](https://github.com/ioccc-src/winner/discussions/new/choose) with
your question. Doing this may be of help to others with a question similar to yours.
**BTW**: If your question just about the
[IOCCC mkiocccentry tools](https://github.com/ioccc-src/mkiocccentry/discussions), please
and suitable open discussion over there, then please consider opening a
[new mkiocccentry discussion](https://github.com/ioccc-src/mkiocccentry/discussions/new/choose)
over there.
If you do not feel, for some reason, comfortable asking your question in public
(although we hope you consider asking it in public for the benefit of others),
then use the [How to contact the IOCCC](contact.html) information to ask
a private question.
**IMPORTANT**: When you ask your question (in public or as a private question)
**PLEASE** try to **NOT** spoil the surprise of your pending submission.
Try to ask for question in a more generic way as this will help others
with a similar question and this will not **give away** what you might be doing
with your submission. If the [IOCCC judges](judges.html) truly need more
information, they will ask (either in public or suggest a private conversation).
Again, **please** don't hesitate to ask: Your question may be something that
others are wondering about as well.
See also [FAQ about making suggestions)(#faq0_5).
<div id="faq0_7">
<div id="markdown">
### FAQ 0.6: - What are the IOCCC best practices for using markdown?
### FAQ 0.7: - What are the IOCCC best practices for using markdown?
</div>
</div>
@@ -483,6 +536,7 @@ See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide.
See also [CommonMark Spec](https://spec.commonmark.org/current/).
<div id="faq1">
## Section 1: History of the IOCCC
</div>