From 864f17e4a5ffdae3a47d55d010eb66d0c867658a Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Wed, 12 Mar 2025 03:27:58 -0700 Subject: [PATCH] Add details on versions New FAQ on what the minimum versions are (this should be updated every contest or updated to refer to the result of the issue I opened at the other repo - post IOCCC28) for each tool. Added details about the new (soon to be released) version of the tools that now search under $PATH. This commit updated the FAQ, the guidelines and the quick start guide. As a reminder you do NOT need to use the upcoming release of the tools and not doing so will not invalidate any of your submissions as it is based on a minimum version, not an exact version. --- faq.html | 34 +++++++++++++++++++++++++--------- faq.md | 40 ++++++++++++++++++++++++++++++---------- next/guidelines.html | 30 ++++++++++++++++++++++++------ next/guidelines.md | 32 ++++++++++++++++++++++++++------ quick-start.html | 17 ++++++++++++----- quick-start.md | 18 +++++++++++++----- 6 files changed, 130 insertions(+), 41 deletions(-) diff --git a/faq.html b/faq.html index f78ebb1aa..62a17a432 100644 --- a/faq.html +++ b/faq.html @@ -425,7 +425,7 @@

IOCCC FAQ Table of Contents

-

This is FAQ version 28.2.15 2025-03-10.

+

This is FAQ version 28.2.16 2025-03-12.

0. Entering the IOCCC: the bare minimum you need to know

  • Q 0.2: What platform should I assume for my submission?
  • Q 0.3: What should I put in my submission Makefile?
  • @@ -740,12 +741,11 @@ directory will be created, with the name based on your IOCCC registrati username, which is in the form of a UUID, and submission number along with the timestamp; see the rules for more details on this, and in particular Rule 17.

    -

    IMPORTANT NOTE: if you run the program outside the repo directory -(specifying the absolute or relative path to the tool) and you have not -installed the tools (and we STRONGLY recommend you do install them), -then you will have to specify the options for the tools that are required like -chkentry(1), txzchk(1) and fnamchk(1). And remember to make sure you have -the latest version so you do not violate Rule 17.

    +

    IMPORTANT NOTE: the tools that require other tools, mkiocccentry(1) and +txzchk(1), will, as of version 2.0.2 2025-03-11, search under $PATH. If +you have an earlier version and you have not installed the tools and run the +tools from outside the repo directory, you will have to use the options to the +tools to set the path to the required tools.

    If the subdirectory in the work directory (based on your submit ID and slot number) already exists, you will have to move it, remove it or otherwise specify a different work directory (NOT the subdirectory), as it needs to be @@ -760,8 +760,24 @@ looked at if the submission wins), run some tests and run a number of other tools, as mentioned above, and as described in the “finer details” section.

    See also the -mkiocccentry repo FAQ -for more up to date information on downloading, compiling, and related FAQ information.

    +FAQ on “what the minimum required versions are for this +contest” +for more details on how to verify you have the correct versions for this +contest.

    +

    Jump to: top

    +
    +

    Q 0.1.6: What are the minimum versions required for this contest?

    +
    +

    At minimum, the tools MUST be version:

    + +

    See also the +FAQ on “obtaining the latest release of the toolkit”.

    Jump to: top

    diff --git a/faq.md b/faq.md index 449efcf06..d6fa625bc 100644 --- a/faq.md +++ b/faq.md @@ -1,6 +1,6 @@ # IOCCC FAQ Table of Contents -This is FAQ version **28.2.15 2025-03-10**. +This is FAQ version **28.2.16 2025-03-12**. ## 0. [Entering the IOCCC: the bare minimum you need to know](#enter_questions) @@ -11,6 +11,7 @@ This is FAQ version **28.2.15 2025-03-10**. - **Q 0.1.3**: How do I compile the mkiocccentry toolkit? - **Q 0.1.4**: How do I install mkiocccentry(1) and related tools? - **Q 0.1.5**: How do I use mkiocccentry? + - **Q 0.1.6**: What are the minimum versions required for this contest? - **Q 0.2**: What platform should I assume for my submission? - **Q 0.3**: What should I put in my submission Makefile? - **Q 0.4**: What should I put in the remarks.md file of my submission? @@ -342,7 +343,6 @@ and will not work from any directory, however. Jump to: [top](#) -
    #### Q 0.1.5: How do I use mkiocccentry?
    @@ -379,12 +379,11 @@ username, which is **in the form of a UUID**, and submission number along with the timestamp; see the [rules](next/rules.html) for more details on this, and in particular [Rule 17](next/rules.html#rule17). -**IMPORTANT NOTE**: if you run the program outside the repo directory -(specifying the absolute or relative path to the tool) and you have not -installed the tools (and we **STRONGLY** recommend you **do** install them), -then you will have to specify the options for the tools that are required like -`chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. And remember to make sure you have -the latest version so you do not violate [Rule 17](next/rules.html#rule17). +**IMPORTANT NOTE**: the tools that require other tools, `mkiocccentry(1)` and +`txzchk(1)`, will, as of version `2.0.2 2025-03-11`, search under `$PATH`. If +you have an earlier version and you have not installed the tools and run the +tools from outside the repo directory, you will have to use the options to the +tools to set the path to the required tools. If the **_subdirectory_ in the _work directory_** (based on your submit ID and slot number) already exists, you will have to move it, remove it or otherwise @@ -402,11 +401,32 @@ tools, as mentioned above, and as described in the "[finer details](#mkiocccentry_details)" section. See also the -[mkiocccentry repo FAQ](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md) -for more up to date information on downloading, compiling, and related FAQ information. +FAQ on "[what the minimum required versions are for this +contest](minimum_versions)" +for more details on how to verify you have the correct versions for this +contest. + Jump to: [top](#) +
    +#### Q 0.1.6: What are the minimum versions required for this contest? +
    + +At minimum, the tools **MUST** be version: + +- `iocccsize(1)`: `"28.15 2024-06-27"`. +- `mkiocccentry(1)`: `"2.0.1 2025-03-02"`. +- `fnamchk(1)`: `"2.0.0 2025-02-28"`. +- `txzchk(1)`: `"2.0.1 2025-03-02"`. +- `chkentry(1)`: `"2.0.1 2025-03-02"`. + +See also the +FAQ on "[obtaining the latest release of the toolkit](#obtaining_mkiocccentry)". + +Jump to: [top](#) + +
    diff --git a/next/guidelines.html b/next/guidelines.html index 595418b03..dc115baa1 100644 --- a/next/guidelines.html +++ b/next/guidelines.html @@ -464,7 +464,7 @@ writing by contacting the judges.

    -These IOCCC guidelines are version 28.45 2025-03-10. +These IOCCC guidelines are version 28.46 2025-03-12.

    The markdown form of these guidelines AFTER THISPERFECTLY okay.

    +NOTE: the updates to these guidelines on 2025-03-12 also explain how the +tools that require other tools now search under $PATH. It is perfectly fine to +not use the newer versions so long as you use the minimum required version of +the tools. See the +FAQ on “minimum required version of the tools” +for more details and the +FAQ on “obtaining the most recent release of the +toolkit” +for more help. +

    +

    Until the contest status becomes open, the IOCCC rules, IOCCC guidelines and the tools in the @@ -577,11 +588,11 @@ We STRONGLY recommend you do install the mkiocccentry toolkit.

    -IMPORTANT NOTE: if you run an IOCCC related tool outside the -mkiocccentry toolkit -directory and you have not installed those tools, then you will have to -specify the options (such as paths) for the tools that are required like -chkentry(1), txzchk(1) and fnamchk(1). +IMPORTANT NOTE: the tools that require other tools, mkiocccentry(1) and +txzchk(1), will, as of version 2.0.2 2025-03-11, search under $PATH. If +you have an earlier version and you have not installed the tools and run the +tools from outside the repo directory, you will have to use the options to the +tools to set the path to the required tools.

    See the @@ -594,6 +605,13 @@ as well as how to upload your submission to the IOCCC.

    +See also the +FAQ on “what the minimum required versions are for this +contest” +for more details on how to verify you have the correct versions for this +contest. +

    +

    While the contest is open, you may modify your previously uploaded submission by rebuilding your submission with the mkiocccentry(1) tool and then re-uploading it to the same slot number on the diff --git a/next/guidelines.md b/next/guidelines.md index 0ab881950..3a6da6253 100644 --- a/next/guidelines.md +++ b/next/guidelines.md @@ -53,7 +53,7 @@ Jump to: [top](#)

    -These [IOCCC guidelines](guidelines.html) are version **28.45 2025-03-10**. +These [IOCCC guidelines](guidelines.html) are version **28.46 2025-03-12**.

    @@ -149,6 +149,18 @@ to follow the guidelines. The options are in a release **AFTER THIS** IOCCC's official release and not updating the toolkit is **PERFECTLY** okay.

    +

    +**NOTE**: the updates to these guidelines on 2025-03-12 also explain how the +tools that require other tools now search under `$PATH`. It is perfectly fine to +not use the newer versions so long as you use the minimum required version of +the tools. See the +FAQ on "[minimum required version of the tools](../faq.html#minimum_versions)" +for more details and the +FAQ on "[obtaining the most recent release of the +toolkit](../faq.html#obtaining_mkiocccentry)" +for more help. +

    +

    Until the contest status becomes **[open](../faq.html#open)**, the [IOCCC rules](rules.html), @@ -195,11 +207,11 @@ We **STRONGLY** recommend you **do** install the

    -**IMPORTANT NOTE**: if you run an IOCCC related tool outside the -[mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry) -directory and you have not installed those tools, then you will have to -specify the options (such as paths) for the tools that are required like -`chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. +**IMPORTANT NOTE**: the tools that require other tools, `mkiocccentry(1)` and +`txzchk(1)`, will, as of version `2.0.2 2025-03-11`, search under `$PATH`. If +you have an earlier version and you have not installed the tools and run the +tools from outside the repo directory, you will have to use the options to the +tools to set the path to the required tools.

    @@ -213,6 +225,14 @@ as well as [how to upload your submission](submit.html) to the IOCCC.

    +

    +See also the +FAQ on "[what the minimum required versions are for this +contest](../faq.html#minimum_versions)" +for more details on how to verify you have the correct versions for this +contest. +

    +

    While the contest is **[open](../faq.html#open)**, you may modify your previously uploaded submission by rebuilding your submission with the diff --git a/quick-start.html b/quick-start.html index 091930c9b..03af66b93 100644 --- a/quick-start.html +++ b/quick-start.html @@ -424,7 +424,7 @@ -

    This quick start guide is version 28.0.1 2025-03-01.

    +

    This quick start guide is version 28.0.2 2025-03-12.

    Entering the IOCCC: the bare minimum you need to know

    @@ -543,10 +543,12 @@ correct your entry and then re-run the mkiocccentry tool.

    If you choose to risk violating Rules, be sure and explain your reason for doing so in your remarks.md file.

    See also Rule 17!

    -

    IMPORTANT NOTE: if you run the program outside the repo directory -(specifying the absolute or relative path to the tool) and you have not -installed the tools (and we STRONGLY recommend you do install them), -then you will have to specify the options for the tools that are required like +

    IMPORTANT NOTE: the tools that require other tools, mkiocccentry(1) and +txzchk(1), will, as of version 2.0.2 2025-03-11, search under $PATH. If +you have an earlier version and you have not installed the tools and run the +tools from outside the repo directory, you will have to use the options to the +tools to set the path to the required tools.

    +

    Do remember to make sure you have the latest vers chkentry(1), txzchk(1) and fnamchk(1). And remember to make sure you have the latest version so you do not violate Rule 17. See the @@ -558,6 +560,11 @@ FAQ on “installing the mkiocccentry tools” and the FAQ on “using the mkiocccentry tools” for more help.

    +

    See also the +FAQ on “what the minimum required versions are for this +contest” +for more details on how to verify you have the correct versions for this +contest.

    7. Upload your submission to the IOCCC submit server

    diff --git a/quick-start.md b/quick-start.md index 15b20e6bf..9adb35a77 100644 --- a/quick-start.md +++ b/quick-start.md @@ -1,4 +1,4 @@ -This quick start guide is version **28.0.1 2025-03-01**. +This quick start guide is version **28.0.2 2025-03-12**.
    @@ -170,10 +170,13 @@ for doing so in your `remarks.md` file. See also [Rule 17](next/rules.html#rule17)! -**IMPORTANT NOTE**: if you run the program outside the repo directory -(specifying the absolute or relative path to the tool) and you have not -installed the tools (and we **STRONGLY** recommend you **do** install them), -then you will have to specify the options for the tools that are required like +**IMPORTANT NOTE**: the tools that require other tools, `mkiocccentry(1)` and +`txzchk(1)`, will, as of version `2.0.2 2025-03-11`, search under `$PATH`. If +you have an earlier version and you have not installed the tools and run the +tools from outside the repo directory, you will have to use the options to the +tools to set the path to the required tools. + +Do remember to make sure you have the latest vers `chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. And remember to make sure you have the latest version so you do not violate [Rule 17](next/rules.html#rule17). See the @@ -186,6 +189,11 @@ and the FAQ on "[using the mkiocccentry tools](faq.html#using_mkiocccentry)" for more help. +See also the +FAQ on "[what the minimum required versions are for this +contest](faq.html#minimum_versions)" +for more details on how to verify you have the correct versions for this +contest.