IOCCC code is for educational and entertainment purposes only. We do NOT -recommend installing any winning IOCCC entry code. Use code found the IOCCC repo -and in the IOCCC web site at your own risk!
+recommend installing any winning IOCCC entry code. Use code found in the IOCCC repo +and in the IOCCC website at your own risk!The IOCCC and the IOCCC judges DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THEY BE LIABLE FOR ANY SPECIAL, diff --git a/SECURITY.md b/SECURITY.md index efa6febeb2..0e605aff89 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -35,8 +35,8 @@ instead. # Important Disclaimer IOCCC code is for **educational and entertainment purposes only**. We do **NOT** -recommend installing any winning IOCCC entry code. Use code found the IOCCC repo -and in the IOCCC web site **at your own risk!** +recommend installing any winning IOCCC entry code. Use code found in the IOCCC repo +and in the IOCCC website **at your own risk!** The [IOCCC](index.html) and the [IOCCC judges](judges.html) DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF diff --git a/contact.html b/contact.html index efa4245b69..06c5f88a9a 100644 --- a/contact.html +++ b/contact.html @@ -444,11 +444,11 @@
If you are trying to:
In general, unless you have a fix, if you want to report something, you should instead first look at the IOCCC issues to see if the diff --git a/contact.md b/contact.md index 555f0396c5..d33f36c789 100644 --- a/contact.md +++ b/contact.md @@ -20,11 +20,11 @@ FAQ on "[submitting a pull request](faq.html#pull_request)". If you are trying to: * **Report a bug in an IOCCC winning entry** - See our -FAQ on "[report entry bug](faq.html#report_bug)" +FAQ on "[reporting an entry bug](faq.html#report_bug)" * **Report an IOCCC website problem** - See our -FAQ on "[report website problem](faq.html#report_web_problem)" +FAQ on "[reporting a website problem](faq.html#report_web_problem)" * **Report a broken or wrong web link** - See our -FAQ on "[report broken link](faq.html#fix_link)" +FAQ on "[reporting a broken link](faq.html#fix_link)" In general, unless you have a fix, if you want to report something, you should instead first look at the [IOCCC issues](https://github.com/ioccc-src/winner/issues) to see if the diff --git a/faq.html b/faq.html index 6af4dd737e..e5573faa5d 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.4 2025-02-03.
try.sh and try.alt.sh scripts?mki
to a maximum, including the mandatory files, defined in
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”,
the
FAQ on “fnamchk”
@@ -694,6 +697,16 @@
Q 0.1.4: How do I use mkiocccentry?in the form of a UUID, and submission number; 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 then you will have to specify the options for the tools that
+are required like chkentry(1), txzchk(1) and fnamchk(1). But even if you
+have installed them but some tools are out of date (in the install path) it will
+cause problems. Additionally, if you do not have the most recent version when
+submitting a tarball it will be rejected for not having the right versions of
+the tools. This is why you MUST make sure you have the most recent version
+of all the tools and you either run it from the repo directory itself OR you
+install them (make install as via sudo or as root).
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
@@ -797,27 +810,36 @@
Q 0.4:
-
First, PLEASE read the IOCCC markdown guidelines.
+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
+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
+
We recommend that you explain how to use your submission. 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
+
We highly recommend that you explain why you think your submission is
well obfuscated.
For those submissions 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.
+as most people who are not humor impaired, as well as the IOCCC judges (who
+might or might not be humour impaired :-) ), 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)
+- 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:
@@ -829,11 +851,13 @@ What does not help:
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 AND rules if this is not clear!
-- leaving the remark section empty.
+- leaving the remark section empty (which would also indicate that you did not
+use
mkiocccentry(1), as it requires it to not be of size 0, though if you only
+include whitespace you would still be violating Rule 17).
Jump to: top
-Q 0.5 What should I do with the try.sh and try.alt.sh scripts?
+Q 0.5: What should I do with the try.sh and try.alt.sh scripts?
If your submission has more than one use, or if you have interesting ways to
invoke your program, perhaps using other commonly installed tools (or tools
@@ -858,6 +882,22 @@
Q 0.5 Wha
example Makefile that you modify for your submission. See the
FAQ on “submission Makefiles.
Jump to: top
+
+Q 0.6: What permissions may my files be and what if I need different permissions?
+
+As Rule 17 states, files in your submission tarball MUST be
+specific permissions. In particular: directories MUST be drwxr-xr-x (i.e.
+0755), the optional files, try.sh or try.alt.sh, if provided, MUST be
+-r-xr-xr-x (i.e. 0555) and all other files MUST be -r--r--r-- (i.e.
+0444).
+If you need a file to be executable, say a script, then make sure you do so in
+the appropriate place in your Makefile. See the
+FAQ on “submission Makefile”
+for more details.
+Do remember that if your submission requires different filenames, then you
+MUST make a COPY of them in your Makefile. See also Rule
+11.
+Jump to: top
diff --git a/faq.md b/faq.md
index f123831371..ef34337120 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.4 2025-02-03**.
## 0. [Entering the IOCCC: the bare minimum you need to know](#enter_questions)
@@ -14,6 +14,7 @@ This is FAQ version **28.2.2 2025-01-30**.
- **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?
- **Q 0.5**: What should I do with the `try.sh` and `try.alt.sh` scripts?
+- **Q 0.6**: What permissions may my files be and what if I need different permissions?
## 1. [Entering the IOCCC: more help and details](#submitting_help)
@@ -217,10 +218,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)"
@@ -314,6 +319,17 @@ username, which is **in the form of a UUID**, and submission number; 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 then you will have to specify the options for the tools that
+are required like `chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. But even if you
+have installed them but some tools are out of date (in the install path) it will
+cause problems. Additionally, if you do not have the most recent version when
+submitting a tarball it will be rejected for not having the right versions of
+the tools. This is why you **MUST** make sure you have the most recent version
+of all the tools and you either run it from the repo directory itself OR you
+install them (`make install` as via `sudo` or as root).
+
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
@@ -431,16 +447,24 @@ Jump to: [top](#)
-First, **PLEASE** read the [IOCCC markdown guidelines](markdown.html).
+**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)
+
+**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:
-We recommend that you explain how to use your entry. Explain the
+We recommend that you explain how to use your submission. 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
+We highly recommend that you explain why you think your submission is
well obfuscated.
For those submissions that win the IOCCC, we often use much of text from the
@@ -448,17 +472,18 @@ For those submissions that win the IOCCC, we often use much of text from the
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.
+as most people who are not humor impaired, as well as the IOCCC judges (who
+might or might not be humour impaired :-) ), 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)
+- 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:
@@ -471,13 +496,15 @@ it, not very obfuscated entries have a minuscule chance to win (although
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](next/guidelines.html) **AND** [rules](next/rules.html) if this is not clear!
-- leaving the remark section empty.
+- leaving the remark section empty (which would also indicate that you did not
+use `mkiocccentry(1)`, as it requires it to not be of size 0, though if you only
+include whitespace you would still be violating [Rule 17](next/rules.html#rule17)).
Jump to: [top](#)
-### Q 0.5 What should I do with the `try.sh` and `try.alt.sh` scripts?
+### Q 0.5: What should I do with the `try.sh` and `try.alt.sh` scripts?
If your submission has more than one use, or if you have interesting ways to
@@ -510,6 +537,30 @@ FAQ on "[submission Makefiles](#makefile).
Jump to: [top](#)
+
+
+
+### Q 0.6: What permissions may my files be and what if I need different permissions?
+
+
+As [Rule 17](#rule17) states, files in your submission tarball **MUST** be
+specific permissions. In particular: directories **MUST** be `drwxr-xr-x` (i.e.
+`0755`), the optional files, `try.sh` or `try.alt.sh`, if provided, **MUST** be
+`-r-xr-xr-x` (i.e. `0555`) and all other files **MUST** be `-r--r--r--` (i.e.
+`0444`).
+
+If you need a file to be executable, say a script, then make sure you do so in
+the appropriate place in your Makefile. See the
+FAQ on "[submission Makefile](#makefile)"
+for more details.
+
+Do remember that if your submission requires different filenames, then you
+**MUST** make a **COPY** of them in your `Makefile`. See also [Rule
+11](next/rules.html#rule11).
+
+
+
+Jump to: [top](#)
diff --git a/markdown.html b/markdown.html
index 6f2d54bb71..aa9b7bf05f 100644
--- a/markdown.html
+++ b/markdown.html
@@ -431,13 +431,13 @@ IOCCC 28th Markdown Guidelines
IOCCC Markdown guidelines version
IMPORTANT: Be sure to read the IOCCC rules and IOCCC
guidelines.
Jump to: top
-
-IOCCC Markdown guidelines
+
+IOCCC Markdown Guidelines Introduction
The IOCCC makes extensive use of markdown.
For example, when submitting to the IOCCC
@@ -454,9 +454,29 @@
IOCCC Markdown guidelines
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
+
+Please DO start 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.
Please do NOT use the name attributes in HTML <a>...</a> hyperlink elements
diff --git a/markdown.md b/markdown.md
index 480e52738e..b823d434eb 100644
--- a/markdown.md
+++ b/markdown.md
@@ -7,7 +7,7 @@
**IMPORTANT**: Be sure to read the [IOCCC rules](next/rules.html) and [IOCCC
@@ -16,8 +16,8 @@ guidelines](next/guidelines.html).
Jump to: [top](#)
-
-## IOCCC Markdown guidelines
+
+## IOCCC Markdown Guidelines Introduction
The IOCCC makes extensive use of [markdown](https://daringfireball.net/projects/markdown/).
@@ -38,11 +38,46 @@ Nevertheless, the IOCCC does have certain practices that we ask authors to follo
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](#)
+
+## Please DO start `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.
+```
+
+
## Please do NOT use the `name` attributes in HTML `...` hyperlink elements
diff --git a/next/Makefile.example b/next/Makefile.example
index 4e54383270..3380c00f8a 100644
--- a/next/Makefile.example
+++ b/next/Makefile.example
@@ -153,12 +153,16 @@ ALT_TARGET=
#
DATA=
-
#################
# build the entry
#################
all: data ${TARGET}
+ # NOTE: only try.sh and try.alt.sh scripts will be made executable in
+ # the tarball so if you need any scripts that are executable, make sure
+ # to use ${CHMOD} +x on them like:
+ #
+ # ${CHMOD} +x foo.sh
.PHONY: all data try clean clobber install
diff --git a/next/guidelines.html b/next/guidelines.html
index 0903d2bde7..cefbde1281 100644
--- a/next/guidelines.html
+++ b/next/guidelines.html
@@ -461,7 +461,7 @@ IOCCC Guidelines version
WHAT’S NEW THIS IOCCC
before this option will work a second time, just like in normal mode.
+
HINTS AND SUGGESTIONS:
are considered more portable.
Jump to: top
-
-Including optional and extra files
-
-
-
-
-
-
-
-
-
- tar --format=v7 -cJf foo.txz directory
-
-
mkiocccentry
txzchk
manually package your submission tarball, you could still be violating Rule
17.
+
+Including optional and extra files
+
+
+
+
+
+
+
+
+
+ tar --format=v7 -cJf foo.txz directory
+
+
+
+
@@ -485,81 +502,6 @@ are considered more portable.
Jump to: [top](#)
-
-# Including optional and extra files
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-```
- tar --format=v7 -cJf foo.txz directory
-```
-
-
-
-
-
-
# `mkiocccentry`
@@ -818,6 +760,83 @@ manually package your submission tarball, you could still be violating [Rule
17](rules.html#rule17).
+
+## Including optional and extra files
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+```
+ tar --format=v7 -cJf foo.txz directory
+```
+
+
+
+
+
+
+
+
28th Internat
IOCCC Rules version
-Jump to: top
TL;DR Rule 17 - Use mkiocccentry
Jump to: top
Rule 17 - The COMPLEX details
@@ -1056,7 +1055,7 @@ Rule 17 - The COMPLEX details
and the CommonMark Spec.
Rule 17 - The COMPLEX details
Rule 17 - The COMPLEX details
NOT be a directory depth > 4.
Rule 17 - The COMPLEX details
+
+
Maximum number of files per subm
Rule 18
-You (the author(s)) MUST own the contents of your submission OR
+
You (the author(s)) MUST own the content of your submission OR
you MUST HAVE PERMISSION from the owner(s) to submit their content.
You MUST NOT submit anything that cannot be submitted under that license.
Jump to: top
diff --git a/next/rules.md b/next/rules.md
index 799cdb90b6..fe0e6cf5a1 100644
--- a/next/rules.md
+++ b/next/rules.md
@@ -51,11 +51,9 @@ Jump to: [top](#)
-Jump to: [top](#)
-
Jump to: [top](#)
@@ -835,7 +833,7 @@ and the [CommonMark Spec](https://spec.commonmark.org/current/).
-
-
-
-*
-*
+*
+*
*
@@ -892,11 +886,11 @@ the exception of files generated by `mkiocccentry(1)` itself, it must have
`^[0-9A-Za-z]+[0-9A-Za-z_+.-]*$` (again, excluding files generated by
`mkiocccentry(1)`).
*
-*
+*
*
*
+
+
+
+
@@ -938,7 +950,8 @@ having your submission rejected for violating [Rule 17](#rule17)!
-You (the author(s)) **MUST** own the contents of your submission **OR**
+You (the author(s)) **MUST** own the content of your submission **OR**
you **MUST HAVE PERMISSION** from the owner(s) to submit their content.
You **MUST NOT** submit anything that cannot be submitted under that license.
diff --git a/next/try.alt.sh b/next/try.alt.sh
old mode 100644
new mode 100755
diff --git a/next/try.sh b/next/try.sh
old mode 100644
new mode 100755
diff --git a/quick-start.html b/quick-start.html
index 77341230e4..ff688bd6f6 100644
--- a/quick-start.html
+++ b/quick-start.html
@@ -512,21 +512,25 @@ 6. Run the mk
FAQ on”how to use mkiocccentry“)
and the mkiocccentry section in the
guidelines.
- mkiocccentry work_dir prog.c Makefile remarks.md [file ...]
+ mkiocccentry [options] workdir topdir
where:
-work_dir
-directory where the entry directory and tarball are formed
workdir
+directory where the submission directory and tarball are formed
topdir
+directory where your files to be packaged are in
+Three files are required to exist in topdir:
+
prog.c
-path to the C source for your entry
path to the C source for your submission
Makefile
-Makefile to build (make all) and cleanup (make clean & make clobber)
Makefile to build (make all) and cleanup (make clean & make clobber) as well
+as the other required rules
remarks.md
Remarks about your entry in markdown format: see the
-FAQ on “remarks.md”
+FAQ on “remarks.md”
for more info.
[file …]
-Optional extra data files to include with your entry
NOTE: Please see our IOCCC markdown guide for important information on using markdown in the IOCCC.
NOTE: It is NOT necessary to install the tools to use them as you can run
@@ -536,10 +540,20 @@
6. Run the mk
submission’s directory. See the
FAQ on “installing mkiocccentry”
at the mkiocccentry repo.
-
If the mkiocccentry tool indicates that there is a problem with your entry,
-especially if it identifies a Rule 2, or any other
-rule, related problem, you are strongly encouraged to revise and correct
-your entry and then re-run the mkiocccentry tool.
+However, an 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 then you will have to specify the options for the
+tools that are required like chkentry(1), txzchk(1) and fnamchk(1). But
+even if you have installed them but some tools are out of date (in the install
+path) it will cause problems. Additionally, if you do not have the most recent
+version when submitting a tarball it will be rejected for not having the right
+versions of the tools. This is why you MUST make sure you have the most
+recent version of all the tools and you either run it from the repo directory
+itself OR you install them (make install as via sudo or as root).
+If the mkiocccentry tool indicates that there is a problem with your
+submission, especially if it identifies a Rule 2, or
+any other rule, related problem, you are strongly encouraged to revise and
+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!
diff --git a/quick-start.md b/quick-start.md
index ad86fb58f1..0ba5b7f3ef 100644
--- a/quick-start.md
+++ b/quick-start.md
@@ -124,33 +124,36 @@ guidelines](next/guidelines.html#mkiocccentry).
```
- mkiocccentry work_dir prog.c Makefile remarks.md [file ...]
+ mkiocccentry [options] workdir topdir
```
where:
-* `work_dir`
+* `workdir`
- directory where the entry directory and tarball are formed
+ directory where the submission directory and tarball are formed
+
+* `topdir`
+
+ directory where your files to be packaged are in
+
+Three files are required to exist in `topdir`:
* `prog.c`
- path to the C source for your entry
+ path to the C source for your submission
* `Makefile`
- Makefile to build (make all) and cleanup (make clean & make clobber)
+ Makefile to build (make all) and cleanup (make clean & make clobber) as well
+ as the other required rules
* `remarks.md`
Remarks about your entry in markdown format: see the
- FAQ on "[remarks.md](#remarks_md)"
+ FAQ on "[remarks.md](faq.html#remarks_md)"
for more info.
-* [file ...]
-
- Optional extra data files to include with your entry
-
**NOTE**: Please see our [IOCCC markdown guide](markdown.html) for **important information** on using markdown in the IOCCC.
**NOTE**: It is *NOT* necessary to install the tools to use them as you can run
@@ -161,10 +164,21 @@ submission's directory. See the
FAQ on "**[installing mkiocccentry](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#install)**"
at the mkiocccentry repo.
-If the `mkiocccentry` tool indicates that there is a problem with your entry,
-especially if it identifies a [Rule 2](next/rules.html#rule2), or any other
-rule, related problem, you are **strongly** encouraged to revise and correct
-your entry and then re-run the `mkiocccentry` tool.
+However, an **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 then you will have to specify the options for the
+tools that are required like `chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. But
+even if you have installed them but some tools are out of date (in the install
+path) it will cause problems. Additionally, if you do not have the most recent
+version when submitting a tarball it will be rejected for not having the right
+versions of the tools. This is why you **MUST** make sure you have the most
+recent version of all the tools and you either run it from the repo directory
+itself OR you install them (`make install` as via `sudo` or as root).
+
+If the `mkiocccentry` tool indicates that there is a problem with your
+submission, especially if it identifies a [Rule 2](next/rules.html#rule2), or
+any other rule, related problem, you are **strongly** encouraged to revise and
+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.