From 81d225f439e60868b0b9595eeaf4d034053e51c9 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Tue, 4 Mar 2025 05:25:25 -0800 Subject: [PATCH 1/2] Change how example remarks is managed The file next/remarks.example.md has been renamed next/remarks.md. From this file a new html file, next/remarks.html, is generated. The first part of the instructions say to download the markdown file and copy it to your submission's directory. The rest is mostly the same but this way one can look at the website and also be aware of the file (and it'll be linked to in the rules and/or guidelines as well). This required updating bin/gen-top-html.sh an bin/md2html.cfg and the Makefile was updated too (with a typo fix also). --- Makefile | 11 +- bin/gen-top-html.sh | 1 + bin/md2html.cfg | 16 + next/remarks.html | 519 ++++++++++++++++++++++++ next/{remarks.example.md => remarks.md} | 16 +- 5 files changed, 552 insertions(+), 11 deletions(-) create mode 100644 next/remarks.html rename next/{remarks.example.md => remarks.md} (55%) diff --git a/Makefile b/Makefile index 92cc1c7ec..0ae2c24b7 100644 --- a/Makefile +++ b/Makefile @@ -341,8 +341,9 @@ help: @echo 'make contact ;: generate contact.html' @echo 'make faq ;: generate faq.html' @echo 'make guidelines ;: generate next/guidelines.hmtl' - @echo 'make markdown ;: generate markdown.hmtl' - @echo 'make pw_change ;: generate the next/pw-change.html page' + @echo 'make markdown ;: generate markdown.html' + @echo 'make remarks ;: generate next/remarks.html' + @echo 'make pw_change ;: generate next/pw-change.html' @echo 'make rules ;: generate next/rules.hmtl' @echo 'make security ;: generate SECURITY.html' @echo 'make thanks ;: generate thanks-for-help.html' @@ -691,6 +692,7 @@ gen_next: ${GEN_TOP_HTML} next/README.md next/guidelines.md next/rules.md next/r ${GEN_TOP_HTML} -v 1 next/guidelines ${GEN_TOP_HTML} -v 1 next/rules ${GEN_TOP_HTML} -v 1 next/register + ${GEN_TOP_HTML} -v 1 next/remarks ${GEN_TOP_HTML} -v 1 next/submit ${GEN_TOP_HTML} -v 1 next/pw-change @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' @@ -703,6 +705,11 @@ pw_change: next/pw-change.md @echo "Perhaps you should change your password!" @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' +remarks: ${GEN_TOP_HTML} next/remarks.md + @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' + @${GEN_TOP_HTML} -v 1 next/remarks + @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' + markdown: ${GEN_TOP_HTML} markdown.md @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' @echo "You want to markdown?" diff --git a/bin/gen-top-html.sh b/bin/gen-top-html.sh index 6e4054341..c849b7edc 100755 --- a/bin/gen-top-html.sh +++ b/bin/gen-top-html.sh @@ -149,6 +149,7 @@ TOP_MD_SET+=("next/guidelines") TOP_MD_SET+=("next/pw-change") TOP_MD_SET+=("next/README") TOP_MD_SET+=("next/register") +TOP_MD_SET+=("next/remarks") TOP_MD_SET+=("next/rules") TOP_MD_SET+=("next/submit") TOP_MD_SET+=("nojs-menu") diff --git a/bin/md2html.cfg b/bin/md2html.cfg index d5c9551aa..74b281fc4 100644 --- a/bin/md2html.cfg +++ b/bin/md2html.cfg @@ -405,6 +405,22 @@ next/register.md -D ../ +next/remarks.md + -H + navbar=empty + -o + bin/subst.default.sh + -s + TITLE=The International Obfuscated C Code Contest + -s + DESCRIPTION=Instructions for remarks.md + -s + KEYWORDS=IOCCC, remarks + -s + HEADER_2=How to write your remarks.md + -D + ../ + next/rules.md -H navbar=empty diff --git a/next/remarks.html b/next/remarks.html new file mode 100644 index 000000000..ae1b69736 --- /dev/null +++ b/next/remarks.html @@ -0,0 +1,519 @@ + + + + + + + + + + + + +The International Obfuscated C Code Contest + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + + + + + +
+
+ +
+
+ Entries +
+
+ + + Winning entries + + + + Winning authors + + + + Location of authors + + + + Bugs and (mis)features + + + + Fixing entries + + + + Updating author info + + + + Thanks for the help + +
+
+ +
+ +
+ Status +
+
+ + + News + + + + Contest status + + + + Rules and guidelines + + + + Markdown guidelines + + + + Security policy + +
+
+ +
+
+ FAQ +
+
+ + + Frequently Asked Questions + + + + Enter the IOCCC + + + + Compiling entries + + + + Running entries + + + + How to help + + +
+
+ +
+
+ About +
+
+ + + Home page + + + + About the IOCCC + + + + The Judges + + + + Contact us + +
+
+
+
+
+ +
+ + + + + + +
+ + IOCCC image by Matt Zucker + +

The International Obfuscated C Code Contest

+

How to write your remarks.md

+
+ + + + +
+✓ +
+ + + + +
+ + + + + +

Instructions

+

IMPORTANT: be SURE to read the IOCCC rules AND the +IOCCC guidelines!

+
    +

  1. Download the +markdown form of these remarks into your submission’s directory.

    2. +

  2. For help with markdown format please see this helpful +guide.

    3. +

  3. Please see and follow the IOCCC markdown +guidelines. Doing this helps the judges +integrate your remarks into a README.md, should you win.

    4. +

  4. Replace the contents of this remarks.md (in your submission directory) with +your remarks.

    5. +

  5. When packaging your submission with mkiocccentry(1), make sure that the +remarks.md is in the topdir.

    6. +
+

What should you say?

+

Please see the +FAQ on “what to put in your remarks”. +

+ + + + +
+ + + + + + +
+ + + +

Coda

+

+ Nu HTML check this web page
+ Jump to top Jump to Content +

+
+ +
+ + + + + + + + diff --git a/next/remarks.example.md b/next/remarks.md similarity index 55% rename from next/remarks.example.md rename to next/remarks.md index dbec0609b..29312d696 100644 --- a/next/remarks.example.md +++ b/next/remarks.md @@ -1,8 +1,10 @@ # Instructions -0. Create an empty file `remarks.md` in your submission directory -(alternatively after reading this file, delete everything in it and rename it -`remarks.md`). +**IMPORTANT**: be **SURE** to read the [IOCCC rules](rules.html) **AND** the +[IOCCC guidelines](guidelines.html)! + +0. Download the +markdown form of these remarks into your submission's directory. 1. For help with markdown format please see this [helpful guide](https://www.markdownguide.org/basic-syntax/). @@ -11,16 +13,12 @@ guide](https://www.markdownguide.org/basic-syntax/). guidelines](https://www.ioccc.org/markdown.html). Doing this helps the judges integrate your remarks into a `README.md`, should you win. -3. After reading this file, write your remarks in your `remarks.md` file (as -mentioned in step 0). +3. Replace the contents of this `remarks.md` (in your submission directory) with +your remarks. 4. When packaging your submission with `mkiocccentry(1)`, make sure that the `remarks.md` is in the `topdir`. -**IMPORTANT NOTE**: make **SURE** you read the IOCCC -[Rules](https://www.ioccc.org/next/rules.html) and -[Guidelines](https://www.ioccc.org/next/guidelines.html)! - # What should you say? Please see the From 467c3342d4ea43bef0c651a6b0e9b665d4f8cd5a Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Tue, 4 Mar 2025 05:30:58 -0800 Subject: [PATCH 2/2] Fix link in FAQ for remarks filename change --- faq.html | 4 ++-- faq.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/faq.html b/faq.html index 0b2f79f44..778135307 100644 --- a/faq.html +++ b/faq.html @@ -850,8 +850,8 @@ the one linked to above.

PLEASE look at the template remarks.md to give you a better idea of how it should be formed, as it has some instructions you should follow:

PLEASE pay especial attention to the instructions, including the IOCCC markdown guidelines. You will observe that it links back to this diff --git a/faq.md b/faq.md index 3766520ab..8331ed47d 100644 --- a/faq.md +++ b/faq.md @@ -503,8 +503,8 @@ Jump to: [top](#) **PLEASE** look at the template remarks.md to give you a better idea of how it should be formed, as it has some instructions you should follow: -- [view template remarks.md](%%REPO_URL%%/next/remarks.example.md) -- [remarks.md template](next/remarks.example.md) +- [view template remarks.md](%%REPO_URL%%/next/remarks.md) +- [remarks.md template](next/remarks.md) **PLEASE** pay especial attention to the instructions, including the [IOCCC markdown guidelines](markdown.html). You will observe that it links back to this