diff --git a/faq.html b/faq.html index 6af4dd737..581d05cd9 100644 --- a/faq.html +++ b/faq.html @@ -425,7 +425,7 @@
This is FAQ version 28.2.2 2025-01-30.
+This is FAQ version 28.2.3 2025-02-02.
MAX_FILE_COUNT) and other information about your submission,
-information about the author (or authors), and then it runs a lot of tests before (if
-all is OK) forming your tarball. After this is done it will additionally run the
-txzchk(1) tool (which runs the fnamchk(1) tool) on the submission tarball.
-The tool chkentry(1) will also be run, before creating the tarball. See the
+information about the author (or authors), and then it runs a lot of tests.
+If everything is OK, it will write the required .auth.json and .info.json
+files, checking each with chkentry(1) and then, if all is OK, it will create
+the tarball. After the tarball is formed, it will run txzchk(1) on it, which
+runs fnamchk(1). If all is OK, your submission tarball should be good to go.
Please see FAQ on “txzchk”, the FAQ on “fnamchk” @@ -797,7 +799,15 @@ the one linked to above.
-First, PLEASE read the IOCCC markdown guidelines.
+PLEASE look at the example remarks.md to give you a better idea of how +it should be formed:
+ +Read the instructions in the file and PLEASE pay especial attention to the +instructions, including the IOCCC markdown guidelines. You will +observe that it links back to this FAQ as to what you should or should not say.
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 diff --git a/faq.md b/faq.md index f12383137..3434e9034 100644 --- a/faq.md +++ b/faq.md @@ -1,6 +1,6 @@ # IOCCC FAQ Table of Contents -This is FAQ version **28.2.2 2025-01-30**. +This is FAQ version **28.2.3 2025-02-02**. ## 0. [Entering the IOCCC: the bare minimum you need to know](#enter_questions) @@ -217,10 +217,14 @@ code, your Makefile, your remarks, any other data files you wish to provide (up to a maximum, including the mandatory files, defined in [limit_ioccc.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h) as `MAX_FILE_COUNT`) and other information about your submission, -information about the author (or authors), and then it runs a lot of tests before (if -all is OK) forming your tarball. After this is done it will additionally run the -`txzchk(1)` tool (which runs the `fnamchk(1)` tool) on the submission tarball. -The tool `chkentry(1)` will also be run, before creating the tarball. See the +information about the author (or authors), and then it runs a lot of tests. + +If everything is OK, it will write the required `.auth.json` and `.info.json` +files, checking each with `chkentry(1)` and then, if all is OK, it will create +the tarball. After the tarball is formed, it will run `txzchk(1)` on it, which +runs `fnamchk(1)`. If all is OK, your submission tarball should be good to go. + +Please see FAQ on "[txzchk](#txzchk)", the FAQ on "[fnamchk](#fnamchk)" @@ -431,7 +435,15 @@ Jump to: [top](#) -First, **PLEASE** read the [IOCCC markdown guidelines](markdown.html). +**PLEASE** look at the example remarks.md to give you a better idea of how +it should be formed: + +- [view example remarks.md](%%REPO_URL%%/next/remarks.example.md) +- [remarks.md example](next/remarks.example.md) + +Read the instructions in the file and **PLEASE** pay especial attention to the +instructions, including the [IOCCC markdown guidelines](markdown.html). You will +observe that it links back to this FAQ as to what you should or should not say. 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: diff --git a/markdown.html b/markdown.html index 6f2d54bb7..aa9b7bf05 100644 --- a/markdown.html +++ b/markdown.html @@ -431,13 +431,13 @@
IMPORTANT: Be sure to read the IOCCC rules and IOCCC guidelines.
Jump to: top
-The IOCCC makes extensive use of markdown. For example, when submitting to the IOCCC @@ -454,9 +454,29 @@ FAQ on “remarks.md submission file”.
Nevertheless, the IOCCC does have certain practices that we ask authors to follow. Some of these relate to use of markdown directly and others relate to injecting HTML into the markdown file.
-In particular there are things we ask people to please NOT use in -markdown files for the IOCCC:
Jump to: top
+remarks.md sections at level 3 (###), increasing for subsections up to 6 (######)IF (it is not required) you do use sections in your remarks.md file (this does
+not apply to other markdown files), PLEASE start at level three:
# Foo <=== no thank you
+ ## Foo <=== no thank you
+Instead, start sections with 3 #s:
### Section 0
+For each subsection of the current section, add another #, up to 6, going back
+to 3 for new sections. For instance:
### Section 0
+ ...
+ #### First subsection of section 0
+ ...
+ ##### Second subsection of section 0
+ ...
+ ###### Third subsection of section 0
+ ...
+ ### Section 1
+ ...
+ Etc.
name attributes in HTML <a>...</a> hyperlink elements