Skip to content

Commit

Permalink
change the way we mark heading tags within FAQ.md
Browse files Browse the repository at this point in the history
We change the way tags are tags within `FAQ.md`
by using empty div sets before the heading.
  • Loading branch information
lcn2 committed Jul 31, 2024
1 parent fe0b0a7 commit 00e4644
Showing 1 changed file with 13 additions and 26 deletions.
39 changes: 13 additions & 26 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@
12. <a href="#keyword">Why do these tools sometimes use the incorrect IOCCC terms?</a>


<div id=="download">
<div id=="download"></div>
## 0. Where can I find the mkiocccentry tool?
</div>

The `mkiocccentry` tool source code is found in the
[mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry).
Expand All @@ -49,9 +48,8 @@ If you don't have `git` you may
and then extract that file.


<div id=="compiling">
<div id=="compiling"></div>
## 1. How do I compile the mkiocccentry tool?
</div>

After downloading the repo (making sure that if you downloaded the zip file that
you unzip it first) move into the _mkiocccentry_ directory:
Expand All @@ -71,9 +69,8 @@ local directory. If something went wrong, see
<a href="#reporting-bugs">how do I report bugs or other issues?</a>


<div id=="package">
<div id=="package"></div>
## 2. How do I package my submission?
</div>

We recommend that you use the `mkiocccentry` tool to package your submission.
If you have not already done so, download the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry)
Expand Down Expand Up @@ -115,19 +112,17 @@ Once you have answered all of the questions, the tool will form a
XZ compressed tarball, in v7 format, under the _work_dir_ directory.


<div id=="makefile">
<div id=="makefile"></div>
## 3. What do I do for the Makefile in my submission?
</div>

Although you are welcome to add additional rules, we recommend that you use the
example Makefile, [Makefile.example](Makefile.example), removing and changing
comments as appropriate, and making sure to add the correct specifics of each
rule.


<div id=="submitting">
<div id=="submitting"></div>
## 4. Can't I just submit my obfuscated C program to the judges?
</div>

No. While we appreciate your enthusiasm for wanting to show us your obfuscated
code, the [IOCCC judges](https://www.ioccc.org/judges.html) request your help by
Expand All @@ -143,9 +138,8 @@ In short, you cannot simply upload your obfuscated C program as it needs to
be in a certain form and the `mkiocccentry` tool does that.


<div id=="mkiocccentry-requirements">
<div id=="mkiocccentry-requirements"></div>
## 5. Do I have to use mkiocccentry to package my submission?
</div>

Technically you do not have to use the `mkiocccentry` tool; however, you run the
risk of having your submission rejected if what you upload to the submit server is
Expand All @@ -162,9 +156,8 @@ contents under that directory are also OK. In particular, that tool tests that
the JSON files are correct.


<div id=="installing">
<div id=="installing"></div>
## 6. Do I need to install this code to use it?
</div>

No, installing the code in this repo is not necessary to use it. These tools
were designed to be used from the top level directory of the source, or after
Expand All @@ -183,9 +176,8 @@ For example:
```


<div id=="help">
<div id=="help"></div>
## 7. How can I learn more about how to use the tools?
</div>

Assuming you have <a href="#download">downloaded</a> and <a
href="#compiling">compiled</a> the code you can get a quick reminder of command
Expand Down Expand Up @@ -224,9 +216,8 @@ Luke!"_ as you may find the code in this repo reasonably un-obfuscated and fairl
well commented.


<div id=="reporting-bugs">
<div id=="reporting-bugs"></div>
## 8. How do I report bugs or other issues?
</div>

Please run the following from the main directory:

Expand Down Expand Up @@ -267,9 +258,8 @@ The script that the make rule runs, `bug_report.sh`, will tell you the name of
the file to upload.


<div id=="how-to-help">
<div id=="how-to-help"></div>
## 9. How can I help test this repo?
</div>

Thank you for any and all help!

Expand All @@ -278,9 +268,8 @@ Please see the
for more details on what you can do to help us.


<div id=="tar">
<div id=="tar"></div>
## 10. What can I do if my system's tar(1) does not support the correct options?
</div>


If your tar does not support the `-J` option you can either use a system
Expand All @@ -293,9 +282,8 @@ Some systems have a `GNU tar` that you can use. For instance FreeBSD has a
specify in the tools the `-t tar` option to make this work.


<div id=="markdown">
<div id=="markdown"></div>
## 11. Where can I find help with formatting markdown files for my submission?
</div>

The IOCCC makes extensive use of [markdown](https://daringfireball.net/projects/markdown/).

Expand All @@ -308,9 +296,8 @@ See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide.
See also [CommonMark Spec](https://spec.commonmark.org/current/).


<div id=="keyword">
<div id=="keyword"></div>
## 12. Why do these tools sometimes use incorrect IOCCC terms?
</div>

According to the [Official IOCCC FAQ 6.9](https://www.ioccc.org/faq.html#terms)
this repo sometimes uses the wrong term. For example the name `mkiocccentry(1)` contains
Expand Down

0 comments on commit 00e4644

Please sign in to comment.