diff --git a/quick-start.html b/quick-start.html index 77341230e..2b73ff130 100644 --- a/quick-start.html +++ b/quick-start.html @@ -512,21 +512,25 @@ the 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:

+

Three files are required to exist in topdir:

+

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,10 @@ However, installing it will make it easier for you as you can run it from your 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.

+

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 ad86fb58f..7e3662627 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,10 @@ 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. +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.