Skip to content

Latest commit

 

History

History
113 lines (69 loc) · 3.69 KB

remarks.example.md

File metadata and controls

113 lines (69 loc) · 3.69 KB
Raw

Instructions

  1. For help with markdown format please see this helpful guide.

  2. Please see the IOCCC markdown guidelines.

  3. Copy this file into your entry directory under the name: remarks.md.

  4. After reading the rest of this file, remove down to and including the line: # END OF INSTRUCTIONS

  5. Add your remarks to the resulting remarks.md file.

IMPORTANT NOTE: make SURE you read the IOCCC Rules and Guidelines!

Sections and subsections

For section titles you should use heading levels i.e. lines that start with # followed by a space. Please start out at three (###). For subsections increase the number of #s up to a maximum of six.

For each new section you can go down to three #s again, increasing for each subsection of that section.

You need not start your remarks with a heading but you may if you wish.

What should you say?

As much or as little as you wish, except for nothing.

What helps:

  • Explaining what your submission does.

  • Tell us how to run your program.

  • State any limitations of your submission in respect of portability and/or input data.

  • Write about the types obfuscations in your submission.

  • Explain how your program works.

  • Tell us interesting facts about your submission.

NOTE: Use of humor can help.

See also the FAQ on "what to put in your remarks".

What does not help:

  • Admitting that your submission is not very obfuscated (you see, the contest is called the IOCCC, not the INVOCCC :-) ); but even if you do not admit it, not very obfuscated submission have a minuscule chance to win (although 2000/tomx is a notable counterexample).

  • Mentioning your name or any identifying information in the remark section (or 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 submission wins. See the guidelines if this is not clear!

  • Leaving the remark section without much content.

See also the FAQ on "what to put in your remarks".

Use mkiocccentry to package and submit your entry

  1. If you have not already done so, register for the IOCCC and obtain your UUID username and submission password.

  2. Form a work_dir directory into which your submission's files will be placed.

  3. Run the mkiocccentry(1) tool.

NOTE: Use ./mkiocccentry -h and/or review the man page by running: man man/man1/mkiocccentry.1.

  1. Answer the mkiocccentry(1) prompts

  2. Upload the resulting compressed tarball to the IOCCC submit server.

IMPORTANT NOTE: see the FAQ on "how to enter the IOCCC for more details for details on entering the contest and the FAQ on "mkiocccentry in simple terms for a brief description of mkiocccentry and the FAQ on "entering the contest in more detail if you want more help with using mkiocccentry.

IMPORTANT NOTE: pay especial attention to Rule 17!

END OF INSTRUCTIONS

Delete through this line, rename as remarks.md and put your comments below, following the instructions above.