From 84ef6b782dda799b9e462041c735c52f6a4ecfe3 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Fri, 18 Oct 2024 16:26:41 -0700 Subject: [PATCH] Get section 0 of FAQ in order This does not mean that there aren't other question/answers under this section just yet but the first questions are those that are in the table of contents and in the correct order. --- faq.html | 104 +++++++++++++++++++++++----------------------- faq.md | 124 ++++++++++++++++++++++++++++--------------------------- 2 files changed, 115 insertions(+), 113 deletions(-) diff --git a/faq.html b/faq.html index 23400c002..5b36478a9 100644 --- a/faq.html +++ b/faq.html @@ -893,6 +893,20 @@ for more up to date information on downloading, compiling, and related FAQ infor Jump to: top
  • +
    +
    +
    +

    Q: What platform should I assume for my submission?

    +
    +
    +
    +

    Your entry must compile with clang or gcc and run under at least one flavor of a UNIX +system that conforms to the SUS, +otherwise known as the The Single UNIX Specification Version 4 +or later SUS.

    +

    Jump to: top

    +
    • +

  • Q: What should I put in my submission Makefile?

    @@ -920,17 +934,47 @@ command that is compatible with GNU Make version 3.81.

    Jump to: top

  • -
    -
    -
    -

    Q: What platform should I assume for my submission?

    +
    +
    +
    +

    Q: What should I put in the remarks.md file of my submission?

    -

    Your entry must compile with clang or gcc and run under at least one flavor of a UNIX -system that conforms to the SUS, -otherwise known as the The Single UNIX Specification Version 4 -or later SUS.

    +

    First, PLEASE read the IOCCC markdown guidelines.

    +

    Next, while you may put in as much or as little as you wish into your entry’s +remarks.md file, we do have few important suggestions:

    +

    We recommend that you explain how to use your entry. Explain the +command line (if any command line options and arguments are used) +and any input or actions if applicable.

    +

    We highly recommend that you explain why you think your entry is +well obfuscated.

    +

    For those entries that win the IOCCC, we often use much of text from the +remarks.md file in the Author’s remarks section of the index.html file. +For this reason, a well written remarks.md file is considered a plus.

    +

    While not required, consider adding bit of humor to your remarks.md +as most people who are not humor impaired, as well as the IOCCC judges +appreciate the opportunity for a fun read as well as a chuckle or two.

    +

    What helps:

    +
      +
    • explaining what your entry does
      • +
    • how to entice it to do what it is supposed to do
      • +
    • what obfuscations are used
      • +
    • what are the limitations of your entry in respect of portability and/or input data
      • +
    • how it works (if you are really condescending)
      • +
    +

    What does not help:

    +
      +
    • admitting that your entry is not very obfuscated (you see, the contest is +called the IOCCC, not the INVOCCC :-) ); but even if you do not admit +it, not very obfuscated entries have a minuscule chance to win (although +2000/tomx is a notable counterexample).
      • +
    • mentioning your name or any identifying information in the remark section (or +in the C code for that matter) - we like to be unbiased during the judging +rounds; we look at the author name only if an entry wins. See the guidelines if +this is not clear!
      • +
    • leaving the remark section empty.
      • +

    Jump to: top

  • @@ -2021,50 +2065,6 @@ of the same theme.

    Jump to: top

  • -
    -
    -
    -

    Q: What should I put in the remarks.md file of my submission?

    -
    -
    -
    -

    First, PLEASE read the IOCCC markdown guidelines.

    -

    Next, while you may put in as much or as little as you wish into your entry’s -remarks.md file, we do have few important suggestions:

    -

    We recommend that you explain how to use your entry. Explain the -command line (if any command line options and arguments are used) -and any input or actions if applicable.

    -

    We highly recommend that you explain why you think your entry is -well obfuscated.

    -

    For those entries that win the IOCCC, we often use much of text from the -remarks.md file in the Author’s remarks section of the index.html file. -For this reason, a well written remarks.md file is considered a plus.

    -

    While not required, consider adding bit of humor to your remarks.md -as most people who are not humor impaired, as well as the IOCCC judges -appreciate the opportunity for a fun read as well as a chuckle or two.

    -

    What helps:

    - -

    What does not help:

    - -

    Jump to: top

    -
    • -

  • Q: Why don’t you publish submissions that do not win?

    diff --git a/faq.md b/faq.md index abcf2f9ca..8a1160221 100644 --- a/faq.md +++ b/faq.md @@ -409,6 +409,23 @@ for more up to date information on downloading, compiling, and related FAQ infor Jump to: [top](#)
    • +
  • +
    +
    +
    +### Q: What platform should I assume for my submission? +
    +
    +
    + +Your entry must compile with **clang** or **gcc** and run under at least one flavor of a UNIX +system that conforms to the [SUS](https://en.wikipedia.org/wiki/Single_UNIX_Specification), +otherwise known as the [The Single UNIX Specification Version 4](https://unix.org/version4/) +or [later SUS](https://unix.org/online.html). + +Jump to: [top](#) + +
  • @@ -446,22 +463,60 @@ Jump to: [top](#)
  • -
    -
    -
    -### Q: What platform should I assume for my submission? +
    +
    +
    +### Q: What should I put in the remarks.md file of my submission?
    -Your entry must compile with **clang** or **gcc** and run under at least one flavor of a UNIX -system that conforms to the [SUS](https://en.wikipedia.org/wiki/Single_UNIX_Specification), -otherwise known as the [The Single UNIX Specification Version 4](https://unix.org/version4/) -or [later SUS](https://unix.org/online.html). +First, **PLEASE** read the [IOCCC markdown guidelines](markdown.html). + +Next, while you may put in as much or as little as you wish into your entry's +`remarks.md` file, we do have few important suggestions: + +We recommend that you explain how to use your entry. Explain the +command line (if any command line options and arguments are used) +and any input or actions if applicable. + +We highly recommend that you explain why you think your entry is +well obfuscated. + +For those entries that win the IOCCC, we often use much of text from the +`remarks.md` file in the _Author's remarks_ section of the `index.html` file. +For this reason, a well written `remarks.md` file is considered a plus. + +While not required, consider adding bit of humor to your `remarks.md` +as most people who are not humor impaired, as well as the IOCCC judges +appreciate the opportunity for a fun read as well as a chuckle or two. + + +#### What helps: + +- explaining what your entry does +- how to entice it to do what it is supposed to do +- what obfuscations are used +- what are the limitations of your entry in respect of portability and/or input data +- how it works (if you are really condescending) + + +#### What does not help: + +- admitting that your entry is not very obfuscated (you see, the contest is +called the **IOCCC**, not the **INVOCCC** :-) ); but even if you do not admit +it, not very obfuscated entries have a minuscule chance to win (although +[2000/tomx](2000/tomx/index.html) is a notable counterexample). +- mentioning your name or any identifying information in the remark section (or +in the C code for that matter) - we like to be unbiased during the judging +rounds; we look at the author name only if an entry wins. See the guidelines if +this is not clear! +- leaving the remark section empty. Jump to: [top](#)
    • +
  • @@ -1681,60 +1736,7 @@ of the same theme. Jump to: [top](#)
    • -
  • -
    -
    -
    -### Q: What should I put in the remarks.md file of my submission? -
    -
    -
    -First, **PLEASE** read the [IOCCC markdown guidelines](markdown.html). - -Next, while you may put in as much or as little as you wish into your entry's -`remarks.md` file, we do have few important suggestions: - -We recommend that you explain how to use your entry. Explain the -command line (if any command line options and arguments are used) -and any input or actions if applicable. - -We highly recommend that you explain why you think your entry is -well obfuscated. - -For those entries that win the IOCCC, we often use much of text from the -`remarks.md` file in the _Author's remarks_ section of the `index.html` file. -For this reason, a well written `remarks.md` file is considered a plus. - -While not required, consider adding bit of humor to your `remarks.md` -as most people who are not humor impaired, as well as the IOCCC judges -appreciate the opportunity for a fun read as well as a chuckle or two. - - -#### What helps: - -- explaining what your entry does -- how to entice it to do what it is supposed to do -- what obfuscations are used -- what are the limitations of your entry in respect of portability and/or input data -- how it works (if you are really condescending) - - -#### What does not help: - -- admitting that your entry is not very obfuscated (you see, the contest is -called the **IOCCC**, not the **INVOCCC** :-) ); but even if you do not admit -it, not very obfuscated entries have a minuscule chance to win (although -[2000/tomx](2000/tomx/index.html) is a notable counterexample). -- mentioning your name or any identifying information in the remark section (or -in the C code for that matter) - we like to be unbiased during the judging -rounds; we look at the author name only if an entry wins. See the guidelines if -this is not clear! -- leaving the remark section empty. - -Jump to: [top](#) - -