Commit Graph
278 Commits
Author SHA1 Message Date
Landon Curt Noll e89afac532 fix indentation for FAQ 10.6.1, update sitemap
We indent FAQ 10.6.1, added in a previous commit, in the
same way we indent 3rd level FAQ numbers.  Also adjusted
the vertical whitespace around the FAQ in `faq.md` to
be consistent with the other FAQ sections.

Updated sitemap.

Ran `make faq sitemap` to perform the above.
2025-08-01 10:20:31 -07:00
Cody Boone Ferguson 682dceeb01 Add FAQ about enabling mastodon push notifications
It is not clear, as the FAQ shows for now, whether this works with just
desktop/computers or not - it is only possible to enable it on computers
(or if it's possible in mobile devices I did not see it though I only
checked with an iPhone).

This FAQ should probably be linked to in the guidelines later on as
right now it says that one should reload the feed as you do not get
notifications unless you are mentioned (assuming you have push
notifications enabled). As one of the pending changes post winners being
announced (02 August 2025 at 11 Pacific) is to clean up the guidelines,
rules and maybe the FAQ (that was rushed towards the end so as to not
delay IOCCC28 even longer) I have not done this.

Rebuilt faq.html. New image under png/.

FAQ version: 28.2.21 2025-07-31.
2025-07-31 04:07:33 -07:00
Landon Curt Noll f29b37e49a improve HTML menus, add social.html, prep for IOCCC28 winners
Prepare for the winners of **IOCCC28**.

> However these are not the 2024 droids you are looking for.  :-)

The HTML menu (both JavaScript and non-JavaScript) has been updated.

The `Status -> Rules and guidelines' have been replaced with two
separate menus `Status -> IOCCC rules` and `Status -> IOCCC guidelines`.

Added a new top level `social.html` page: built from a new `social.md`.

Sorted rules for building specific web pages in the top level `Makefile`.
Added `make social` to make the `social.html` page from `social.md`.

The `bin/gen-top-html.sh` now is able to process a argument of **social**
to process the new top level `social.html` page.

Changed `bin/gen-top-html.sh` VERSION from "2.0.0 2025-03-13"
to "2.0.1 2025-07-25".

Below `About -> Home page` a new `About -> IOCCC social media` menu item
as added.

Because the menu change touched every HTML file, we changed the general
copyright date range for HTML files from "1984-2024" to "1984-2025"
due to the extensive changes made for **IOCCC28**.

Those markdown files that were modified in 2025 had their copyright date
range also changed from "1984-2024" to "1984-2025".

Rebuilt tarballs and sitemap due to the extensive HTML rebuilding.

Ran `make update` to perform the above.
2025-07-26 13:06:29 -07:00
Cody Boone Ferguson 1b3253117e Add FAQs about submission server per recent talks
The questions:

    Can I download my submission tarball from the submit server?
    Can I delete a submission from the submit server?

were added per brief discussion in IOCCC28.
2025-06-11 07:49:29 -07:00
Cody Boone Ferguson 11ae8bbc7c Fix title for FAQ 1.7 in TOC
It was missing 'LLM' as well.
2025-06-10 07:21:59 -07:00
Landon Curt Noll 4711e16ecd fixed mkiocccentry typo in FAQ as report by Discord user @neonstz 2025-05-26 13:55:17 -07:00
Landon Curt Noll 49db188d20 FAQ version 28.2.17 2025-05-18
Added FAQ 5.12 regarding how to compile entries that use ncurses if we
only have the old classic curses.

Clarified how FAQ 5.2 relates to FAQ 0.2.

Update sitemap.

Tested the above via `make quick_www timestamp` on macOS.
2025-05-18 04:36:44 -07:00
Cody Boone Ferguson 018d721858 Fix another link in FAQ
A link to #install was in more than one part of the menu so it was
removed.
2025-03-15 02:50:24 -07:00
Cody Boone Ferguson 8d71bb0802 Fix FAQ link for iocccsize.h at mkiocccentry 2025-03-15 02:48:14 -07:00
Landon Curt Noll 06f26f2220 update FAQ and news as per new mkiocccentry release
Added news based on the recent
[release 2.4.3 2025-03-11](https://github.com/ioccc-src/mkiocccentry/releases/tag/2.4.3)
of the [mkiocccentry toolkit](https://github.com/ioccc-src/mkiocccentry).

Updated the FAQ with additional information about the above mentioned release.

Fixed use of double blank lines in `faq.md` so that they:

- precede all markdown headings
- precede and follow all "Jump to top" lines

Added missing "Jump to top" lines.

Fixed Section 2 internal link.

Performed `make www gen_status gen_sitemap timestamp` to update the website.
2025-03-12 21:04:37 -07:00
Cody Boone Ferguson 0f1198b48e Fix link in FAQ 2025-03-12 03:35:01 -07:00
Cody Boone Ferguson 864f17e4a5 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.
2025-03-12 03:27:58 -07:00
Cody Boone Ferguson 8968cf8904 Update FAQ and guidelines about new options
The new options to mkiocccentry are -x to delete the submission
directory if if it already exists and the -u uuidfile and -U uuidstr
options.

NOTE: it is NOT required to update the tools for this IOCCC and you do
NOT have to read the updated guidelines to follow the guidelines for
this IOCCC.
2025-03-10 06:28:54 -07:00
Cody Boone Ferguson 4d34c9d759 Fix version checks related FAQ
On second thoughts: there is a potential issue down the road with max
version checks so this change was rolled back.
2025-03-09 12:39:02 -07:00
Cody Boone Ferguson c8730660f5 Updated FAQ per recent mkiocccentry issues
The warnings highbit_warning, wordbuf_warning and first_rule_is_all are
no longer used and will be removed for IOCCC29 and beyond. Thus the
tools no longer care about them.

There were other additions to mkiocccentry like the useful -u uuid
option to read in your UUID from a file so you don't have to copy paste
it per submission. Although that would be useful in the guidelines to
do that would require the version update which is problematic in an open
contest. Thus it can be added for IOCCC29 after this one.

IMPORTANT NOTE: you do NOT have to update the tools unless you want to!
The submit server will no longer flag submissions with those booleans
set to true and when the judges run the tools they won't flag them
either. So if you are just fine with what you're doing, and if the
recent fixes do not have an impact on your work you are perfectly fine
using the current versions you have as version requirements are no
longer a single value but a range. Of course you might still wish to
check that you weren't flagged for some other issue but you no longer
have to worry about those three warnings.
2025-03-09 11:13:52 -07:00
Cody Boone Ferguson 55c9638b56 Make important fix in FAQ about git fetch
After my final commit and merge in mkiocccentry pre-release a pull did
not get the tag. I had to do:

    git fetch --all --tags

instead. So to make sure everyone has the correct tag I have added this
to the FAQ (replacing the 'git fetch' by itself).

Regenerated faq.html.
2025-03-05 08:45:28 -08:00
Cody Boone Ferguson 49609b0ead Final edits before IOCCC28 (I hope :-) )
Renamed some FAQs (typos and/or other things).

Fix a number of typos in various files (including markdown format
errors).

Rules and guidelines should be relatively good although as there is a
lot to get through and not much time left maybe I missed something (I
also kind of cheated doing the final checks with the guidelines rather
than going through them all again).

The next/try.sh and next/try.alt.sh scripts have had updates as well and
the next/Makefile.example was modified too.

The index.html page now has an anchor for goals of the contest so that
the goals in the rules could simply link to it in index.html.

Although some text had to be added (and some corrected) a reasonable
amount of text was also removed as it was elsewhere or was extraneous in
some way.
2025-03-04 12:11:08 -08:00
Cody Boone Ferguson 467c3342d4 Fix link in FAQ for remarks filename change 2025-03-04 05:30:58 -08:00
Landon Curt Noll 0aff81f35e improve and expand submit text, use 00.00 as a sample UUID 2025-03-03 13:06:43 -08:00
Landon Curt Noll 69cfd2122e fixed use of CA flags 2025-03-02 13:54:42 -08:00
Cody Boone Ferguson da9064d95b Fixes in rules
This includes the FAQ as there is an FAQ about Rule 17.
2025-03-01 14:37:13 -08:00
Cody Boone Ferguson fbe4609cc9 sgit -e 's/web site/website/g'
A choice was made a while back to use website and not web site so
changed all new references of 'web site' to 'website':

    sgit -e 's/web site/website/g' '*.md' '*.html'

As this also occurs in the FAQ and there were some minor mods (just
textual, including some fun, not a new FAQ) these are included too.
2025-03-01 10:32:08 -08:00
Landon Curt Noll 87def0e6c9 attempt to fix Duplicate ID HTML errors in FAQ 2025-03-01 02:07:51 -08:00
Landon Curt Noll bf6d0a3574 experiment to move much of Rule 17 text into an FAQ
In order simplify the write-up of the actual Rule 17
into a new FAQ 1.8.  The somewhat shorted Rule 17 text
now refers to checks performed by tools, encourages
their use, discourages their misuse (overriding limits),
and is easier to read: we think.
2025-03-01 01:42:21 -08:00
Landon Curt Noll 820327cc97 add FAQ 1.7 2025-02-28 23:42:01 -08:00
Landon Curt Noll fadb1dde0d resolve issue #57
Moved information about the fields of `status.json` to FAQ 10.11.
2025-02-28 22:46:36 -08:00
Cody Boone Ferguson 65cf447087 Update FAQ, guidelines and quick start
This addresses most (if not all) of the recent changes to chkentry(1)
though a more thorough check will be made later after the mkiocccentry
code freeze.
2025-02-27 14:56:01 -08:00
Cody Boone Ferguson 664a7b57bd Various updates/fixes for recent chkentry mods 2025-02-26 12:20:55 -08:00
Cody Boone Ferguson 50b9f69398 Update FAQ for mkiocccentry process
I have thought of and plugged additional holes in the process (same with
txzchk but that's beyond the scope of the document) so the FAQ was
updated for this.

Also because it is a long list of steps there is now a TL;DR part above
it.

There was an order issue in the list as well.
2025-02-12 16:33:15 -08:00
Cody Boone Ferguson 43574e6f05 Minor fixes in FAQ and guidelines
The FAQ stated (due to a mistake in the issue in the mkiocccentry repo)
that the submission directory (under workdir) has the timestamp in it
but that is not true. Instead the tarball filename has the timestamp.

Typo fix in guidelines.
2025-02-10 15:49:48 -08:00
Cody Boone Ferguson 1c5f14f3e0 More updates to FAQ for mkiocccentry process
Missing steps were added and other things which have changed (fixed)
have also bee noted.

There was also a typo fix in the rules.
2025-02-10 13:28:41 -08:00
Cody Boone Ferguson f57acf1df6 Format fix in FAQ 2025-02-09 13:54:06 -08:00
Cody Boone Ferguson 2c3b47da57 More updates to FAQ about mkiocccentry process
The list now details every step taken and the question was also changed
to help make it easier to find (one need not read this but if they want
to it is now in the correct order).
2025-02-09 13:49:02 -08:00
Cody Boone Ferguson 943e3077b9 Minor fix in FAQ about mkiocccentry process 2025-02-08 18:19:14 -08:00
Cody Boone Ferguson a33a9048ad Minor fix in mkiocccentry process in FAQ 2025-02-08 18:14:19 -08:00
Cody Boone Ferguson 949cdced67 Typo fix in FAQ 2025-02-08 18:01:35 -08:00
Cody Boone Ferguson c6e1c09401 Update FAQ and rules for mkiocccentry
Additional things were added to the process (and as for the rules it
notes that remarks.md is only checked for size > 0, not that it has
content).
2025-02-08 10:34:24 -08:00
Cody Boone Ferguson f5bf279807 Update FAQ about new mkiocccentry process 2025-02-07 11:58:19 -08:00
Cody Boone Ferguson d2c6b42078 Add important note about mkiocccentry execution
It is highly recommended that you run the tool from either the repo
directory itself (making sure you have the most up to date version of
course) or make sure you have installed it (also making sure you have
the most recent version). Not doing this will cause issues with checks
and in the case of out of date versions the submission would be rejected
due to violating rule 17. One can specify the options to mkiocccentry
for the tools required but if you forget or don't have the most up to
date version you will very likely run into problems.
2025-02-06 10:13:53 -08:00
Cody Boone Ferguson a2e216ec82 Update rules, guidelines and FAQ for file perms
Rule 17 mandates specific file permissions for files/directories in
submission tarballs but the documentation did not state this. More work
might need to be done here but it should be better now.
2025-02-03 07:43:52 -08:00
Cody Boone Ferguson 52deabd02a Add remarks.example.md, update FAQ/guidelines
The next/remarks.example.md filename is kind of a misnomer but it was
named this way to match Makefile.example. It has brief instructions
along with a link to the FAQ about what one should put in their
remarks.md file (and the FAQ links to the new file as a starting point
as it has instructions).

The markdown guidelines were updated to note that if one does use
sections in remarks.md file they should start out at heading level 3
(###) and for each subsection increment it by one (up to level 6).
2025-02-02 10:16:35 -08:00
Cody Boone Ferguson db6fd9ab66 Update FAQ, guidelines and rules
The new syntax (though not all functionality is yet finished) of
mkiocccentry does not match what was in the FAQ, guidelines and rules.

Also added an important reminder to use v7 format with tarballs as not
doing so can reveal who you are which would break the rules. This is
mentioned in the rules and guidelines, showing how to create such a
tarball.

More work does have to be done with these two things however.
2025-01-30 11:43:00 -08:00
Cody Boone Ferguson 6b03ab032b Fix best of show/grand prize FAQ list 2025-01-30 11:12:30 -08:00
Cody Boone Ferguson b4db17eeeb Typo fix in FAQ 2025-01-26 11:33:51 -08:00
Landon Curt Noll fa6458fd40 update use of chkentry to use new arg order
The `chkentry(1)` tool was changed so that the `.auth.json`
arg comes before the `.info.json` arg.  These changes are
needed to accommodate and document that change.

Also the use of the single arg as a directory was
removed from documentation (until issue #940 is addressed).
2025-01-18 12:23:38 -08:00
Landon Curt Noll fcc7ac5d04 Merge pull request #55 from xexyl/tarballs
Add details on submitting extra files
2025-01-18 10:10:17 -08:00
Cody Boone Ferguson b65e85678f Add details on submitting extra files
The FAQ, guidelines and rules have been updated to reflect recent
discussions and modifications to the maximum number of files.

A new FAQ entry has been added. The guidelines talk about including
extra tarballs and rule 17 has been updated as well. Some of this was
copied directly from discussion with Landon.

Some minor other fixes were made in the guidelines and rules (mostly
wording).
2025-01-18 09:05:58 -08:00
Landon Curt Noll 3dc3f7e75f improve references to source code that inspired the IOCCC
Updated `faq.md` and `README.md` to point at the BSD source for the
old Bourne shell.  Mentioned the GENIX operating system for the NS
SYS16 system.  Added a note that the links are only approximations
of the BSD code that inspired the IOCCC.
2025-01-18 08:42:11 -08:00
Landon Curt Noll de727a497c modify PR #54
Hello @tanaydin,

We are about to modify the result of your PR #54, @tanaydin to include
a link to the finger daemon source.  Unfortunately the finger daemon
source is not found in that 4.2BSD repo, so we had to dip into the
[4.3BSD-Reno](https://github.com/dank101/4.3BSD-Reno) repo, which isn't
exactly correct as that post-dates the 1984 IOCCC starting event but
will have to do.

We modified the link to use HTML "Left Parenthesis" and "Right Parenthesi"
as per [IOCCC markdown guidelines regarding LITERAL “(” or “)” in
markdown link titles](https://www.ioccc.org/markdown.html#parentheses)
in order to your mod to pass the web site test code.

We also modified the references in the FAQ, as per your suggestion.

We also performed needed changes to update the associated HTML files.

We thank you for recommending this change.

Stay tuned for the update.
2025-01-18 01:50:22 -08:00
Cody Boone Ferguson 3626027455 Add details about -s seed/-d to FAQ and guidelines 2025-01-16 11:32:32 -08:00