Files
Cody Boone Ferguson 81d225f439 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).
2025-03-04 05:25:25 -08:00

26 lines
864 B
Markdown

# Instructions
**IMPORTANT**: be **SURE** to read the [IOCCC rules](rules.html) **AND** the
[IOCCC guidelines](guidelines.html)!
0. <a href="remarks.md" download="remarks.md">Download the
markdown form</a> 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/).
2. Please see and follow the [IOCCC markdown
guidelines](https://www.ioccc.org/markdown.html). Doing this helps the judges
integrate your remarks into a `README.md`, should you win.
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`.
# What should you say?
Please see the
FAQ on "[what to put in your remarks](../faq.html#remarks)".