Merge pull request #121 from xexyl/remarks

This commit is contained in:
Landon Curt Noll authored and GitHub committed 2025-03-04 07:08:47 -08:00
commit 4975257fa4
7 files changed
+556 -15

No files matched your search

+9 -2
View File
@@ -341,8 +341,9 @@ help:
@echo 'make contact ;: generate contact.html'
@echo 'make faq ;: generate faq.html'
@echo 'make guidelines ;: generate next/guidelines.hmtl'
@echo 'make markdown ;: generate markdown.hmtl'
@echo 'make pw_change ;: generate the next/pw-change.html page'
@echo 'make markdown ;: generate markdown.html'
@echo 'make remarks ;: generate next/remarks.html'
@echo 'make pw_change ;: generate next/pw-change.html'
@echo 'make rules ;: generate next/rules.hmtl'
@echo 'make security ;: generate SECURITY.html'
@echo 'make thanks ;: generate thanks-for-help.html'
@@ -691,6 +692,7 @@ gen_next: ${GEN_TOP_HTML} next/README.md next/guidelines.md next/rules.md next/r
${GEN_TOP_HTML} -v 1 next/guidelines
${GEN_TOP_HTML} -v 1 next/rules
${GEN_TOP_HTML} -v 1 next/register
${GEN_TOP_HTML} -v 1 next/remarks
${GEN_TOP_HTML} -v 1 next/submit
${GEN_TOP_HTML} -v 1 next/pw-change
@echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-='
@@ -703,6 +705,11 @@ pw_change: next/pw-change.md
@echo "Perhaps you should change your password!"
@echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-='
remarks: ${GEN_TOP_HTML} next/remarks.md
@echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-='
@${GEN_TOP_HTML} -v 1 next/remarks
@echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-='
markdown: ${GEN_TOP_HTML} markdown.md
@echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-='
@echo "You want to markdown?"
+1
View File
@@ -149,6 +149,7 @@ TOP_MD_SET+=("next/guidelines")
TOP_MD_SET+=("next/pw-change")
TOP_MD_SET+=("next/README")
TOP_MD_SET+=("next/register")
TOP_MD_SET+=("next/remarks")
TOP_MD_SET+=("next/rules")
TOP_MD_SET+=("next/submit")
TOP_MD_SET+=("nojs-menu")
+16
View File
@@ -405,6 +405,22 @@ next/register.md
-D
../
next/remarks.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Instructions for remarks.md
-s
KEYWORDS=IOCCC, remarks
-s
HEADER_2=How to write your remarks.md
-D
../
next/rules.md
-H
navbar=empty
+2 -2
View File
@@ -850,8 +850,8 @@ the one linked to above.</p>
<p><strong>PLEASE</strong> 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:</p>
<ul>
<li><a href="https://github.com/ioccc-src/winner/blob/master/next/remarks.example.md">view template remarks.md</a></li>
<li><a href="next/remarks.example.md">remarks.md template</a></li>
<li><a href="https://github.com/ioccc-src/winner/blob/master/next/remarks.md">view template remarks.md</a></li>
<li><a href="next/remarks.md">remarks.md template</a></li>
</ul>
<p><strong>PLEASE</strong> pay especial attention to the instructions, including the <a href="markdown.html">IOCCC
markdown guidelines</a>. You will observe that it links back to this
+2 -2
View File
@@ -503,8 +503,8 @@ Jump to: [top](#)
**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)
- [view template remarks.md](%%REPO_URL%%/next/remarks.md)
- [remarks.md template](next/remarks.md)
**PLEASE** pay especial attention to the instructions, including the [IOCCC
markdown guidelines](markdown.html). You will observe that it links back to this
+519
View File
@@ -0,0 +1,519 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- START: two lines up starts content from: inc/top.default.html -->
<!-- END: this line ends content from: inc/top.default.html -->
<!-- START: this line starts content from: inc/head.default.html -->
<head>
<link rel="stylesheet" href="../ioccc.css">
<link href="https://fonts.googleapis.com/css2?family=Outfit:wght@100..900&display=swap" rel="stylesheet">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>The International Obfuscated C Code Contest</title>
<link rel="icon" type="image/x-icon" href="../favicon.ico">
<meta name="description" content="Instructions for remarks.md">
<meta name="keywords" content="IOCCC, remarks">
</head>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- END: this line ends content from: inc/head.default.html -->
<!-- -->
<!-- This web page was formed via the tool: bin/gen-top-html.sh -->
<!-- The content of main section of this web page came from: next/remarks.md -->
<!-- -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- !!! Do not modify this web page, instead modify the file: next/remarks.md !!! -->
<!-- !!! Do not modify this web page, instead modify the file: next/remarks.md !!! -->
<!-- !!! Do not modify this web page, instead modify the file: next/remarks.md !!! -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- Markdown content was converted into HTML via the tool: bin/md2html.sh -->
<!-- START: this line starts content from: inc/body.default.html -->
<body>
<!-- END: this line ends content from: inc/body.default.html -->
<!-- START: this line starts content from: inc/topbar.default.html -->
<div class="theader">
<nav class="topbar">
<div class="container">
<div class="logo">
<a href="../index.html" class="logo-link">
IOCCC
</a>
</div>
<div class="topbar-items">
<div class="item">
<span class="item-header">
Entries
</span>
<div class="sub-item">
<div class="outfit-font">
<a href="../years.html" class="sub-item-link">
Winning entries
</a>
</div>
<div class="outfit-font">
<a href="../authors.html" class="sub-item-link">
Winning authors
</a>
</div>
<div class="outfit-font">
<a href="../location.html" class="sub-item-link">
Location of authors
</a>
</div>
<div class="outfit-font">
<a href="../bugs.html" class="sub-item-link">
Bugs and (mis)features
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#fix_an_entry" class="sub-item-link">
Fixing entries
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#fix_author" class="sub-item-link">
Updating author info
</a>
</div>
</div>
</div>
<div class="item">
<span class="item-header">
Status
</span>
<div class="sub-item">
<div class="outfit-font">
<a href="../news.html" class="sub-item-link">
News
</a>
</div>
<div class="outfit-font">
<a href="../status.html" class="sub-item-link">
Contest status
</a>
</div>
<div class="outfit-font">
<a href="../next/index.html" class="sub-item-link">
Rules and guidelines
</a>
</div>
<div class="outfit-font">
<a href="../markdown.html" class="sub-item-link">
Markdown guidelines
</a>
</div>
<div class="outfit-font">
<a href="../SECURITY.html" class="sub-item-link">
Security policy
</a>
</div>
</div>
</div>
<div class="item">
<span class="item-header">
FAQ
</span>
<div class="sub-item">
<div class="outfit-font">
<a href="../faq.html" class="sub-item-link">
Frequently Asked Questions
</a>
</div>
<div class="outfit-font">
<a href="../quick-start.html#enter" class="sub-item-link">
Enter the IOCCC
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#compiling" class="sub-item-link">
Compiling entries
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#running_entries" class="sub-item-link">
Running entries
</a>
</div>
<div class="outfit-font">
<a href="../faq.html#help" class="sub-item-link">
How to help
</a>
</div>
</div>
</div>
<div class="item">
<span class="item-header">
About
</span>
<div class="sub-item">
<div class="outfit-font">
<a href="../index.html" class="sub-item-link">
Home page
</a>
</div>
<div class="outfit-font">
<a href="../about.html" class="sub-item-link">
About the IOCCC
</a>
</div>
<div class="outfit-font">
<a href="../judges.html" class="sub-item-link">
The Judges
</a>
</div>
<div class="outfit-font">
<a href="../thanks-for-help.html" class="sub-item-link">
Thanks for the help
</a>
</div>
<div class="outfit-font">
<a href="../contact.html" class="sub-item-link">
Contact us
</a>
</div>
</div>
</div>
</div>
</div>
</nav>
<div class="header-mobile-menu">
<noscript>
<a href="../nojs-menu.html" class="topbar-js-label">
Please Enable JavaScript
</a>
</noscript>
<button id="header-open-menu-button" class="topbar-mobile-menu">
<img
src="../png/hamburger-icon-open.png"
alt="hamburger style menu icon - open state"
width=48
height=48>
</button>
<button id="header-close-menu-button" class="hide-content">
<img
src="../png/hamburger-icon-closed.png"
alt="hamburger style menu icon - closed state"
width=48
height=48>
</button>
<div id="mobile-menu-panel" class="hide-content">
<div class="mobile-menu-container">
<div class="mobile-menu-wrapper">
<div class="mobile-menu-item">
Entries
</div>
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="../years.html">
Winning entries
</a>
<a class="mobile-submenu-item" href="../authors.html">
Winning authors
</a>
<a class="mobile-submenu-item" href="../location.html">
Location of authors
</a>
<a class="mobile-submenu-item" href="../bugs.html">
Bugs and (mis)features
</a>
<a class="mobile-submenu-item" href="../faq.html#fix_an_entry">
Fixing entries
</a>
<a class="mobile-submenu-item" href="../faq.html#fix_author">
Updating author info
</a>
<a class="mobile-submenu-item" href="../thanks-for-help.html">
Thanks for the help
</a>
</div>
</div>
<div class="mobile-menu-wrapper">
<div class="mobile-menu-item">
Status
</div>
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="../news.html">
News
</a>
<a class="mobile-submenu-item" href="../status.html">
Contest status
</a>
<a class="mobile-submenu-item" href="../next/index.html">
Rules and guidelines
</a>
<a class="mobile-submenu-item" href="../markdown.html">
Markdown guidelines
</a>
<a class="mobile-submenu-item" href="../SECURITY.html">
Security policy
</a>
</div>
</div>
<div class="mobile-menu-wrapper">
<div class="mobile-menu-item">
FAQ
</div>
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="../faq.html">
Frequently Asked Questions
</a>
<a class="mobile-submenu-item" href="../quick-start.html#enter">
Enter the IOCCC
</a>
<a class="mobile-submenu-item" href="../faq.html#compiling">
Compiling entries
</a>
<a class="mobile-submenu-item" href="../faq.html#running_entries">
Running entries
</a>
<a class="mobile-submenu-item" href="../faq.html#help">
How to help
</a>
</div>
</div>
<div class="mobile-menu-wrapper">
<div class="mobile-menu-item">
About
</div>
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="../index.html">
Home page
</a>
<a class="mobile-submenu-item" href="../about.html">
About the IOCCC
</a>
<a class="mobile-submenu-item" href="../judges.html">
The Judges
</a>
<a class="mobile-submenu-item" href="../contact.html">
Contact us
</a>
</div>
</div>
</div>
</div>
</div>
</div>
<script>
var headerOpenMenuButton = document.getElementById("header-open-menu-button");
var headerCloseMenuButton = document.getElementById("header-close-menu-button");
var mobileMenuPanel = document.getElementById("mobile-menu-panel");
headerOpenMenuButton.addEventListener("click", () => {
headerOpenMenuButton.classList.remove("topbar-mobile-menu");
headerOpenMenuButton.classList.add("hide-content");
headerCloseMenuButton.classList.remove("hide-content");
headerCloseMenuButton.classList.add("topbar-mobile-menu");
mobileMenuPanel.classList.remove("hide-content");
mobileMenuPanel.classList.add("topbar-mobile-panel");
});
headerCloseMenuButton.addEventListener("click", () => {
headerCloseMenuButton.classList.remove("topbar-mobile-menu");
headerCloseMenuButton.classList.add("hide-content");
mobileMenuPanel.classList.add("hide-content");
mobileMenuPanel.classList.remove("topbar-mobile-panel");
headerOpenMenuButton.classList.add("topbar-mobile-menu");
headerOpenMenuButton.classList.remove("hide-content");
});
</script>
<!-- END: this line ends content from: inc/topbar.default.html -->
<!-- START: this line starts content from: inc/header.default.html -->
<div class="header">
<a href="../2011/zucker/index.html">
<img src="../png/ioccc.png"
alt="IOCCC image by Matt Zucker"
width=300
height=110>
</a>
<h1>The International Obfuscated C Code Contest</h1>
<h2>How to write your remarks.md</h2>
</div>
<!-- END: this line ends content from: inc/header.default.html -->
<!-- START: this line starts content from: inc/navbar.empty.html -->
<div class="navbar">
<a class="Right" href="https://validator.w3.org/nu/?doc=https%3A%2F%2Fwww.ioccc.org%2Fnext%2Fremarks.html">&#x2713;</a>
</div>
<!-- END: this line ends content from: inc/navbar.empty.html -->
<!-- START: this line starts content from: inc/before-content.default.html -->
<div class="content" id="content">
<!-- END: this line ends content from: inc/before-content.default.html -->
<!-- START: this line starts content for HTML phase 21 by: bin/pandoc-wrapper.sh via bin/md2html.sh -->
<!-- BEFORE: 1st line of markdown file: next/remarks.md -->
<h1 id="instructions">Instructions</h1>
<p><strong>IMPORTANT</strong>: be <strong>SURE</strong> to read the <a href="rules.html">IOCCC rules</a> <strong>AND</strong> the
<a href="guidelines.html">IOCCC guidelines</a>!</p>
<ol start="0" type="1">
<li><p><a href="remarks.md" download="remarks.md">Download the
markdown form</a> of these remarks into your submission’s directory.</p></li>
<li><p>For help with markdown format please see this <a href="https://www.markdownguide.org/basic-syntax/">helpful
guide</a>.</p></li>
<li><p>Please see and follow the <a href="https://www.ioccc.org/markdown.html">IOCCC markdown
guidelines</a>. Doing this helps the judges
integrate your remarks into a <code>README.md</code>, should you win.</p></li>
<li><p>Replace the contents of this <code>remarks.md</code> (in your submission directory) with
your remarks.</p></li>
<li><p>When packaging your submission with <code>mkiocccentry(1)</code>, make sure that the
<code>remarks.md</code> is in the <code>topdir</code>.</p></li>
</ol>
<h1 id="what-should-you-say">What should you say?</h1>
<p>Please see the
FAQ on “<a href="../faq.html#remarks">what to put in your remarks</a>”.
<!-- AFTER: last line of markdown file: next/remarks.md --></p>
<!-- END: this line ends content for HTML phase 21 by: bin/pandoc-wrapper.sh via bin/md2html.sh -->
<!-- START: this line starts content from: inc/after-content.default.html -->
</div>
<!-- END: this line ends content from: inc/after-content.default.html -->
<!-- START: this line starts content from: inc/footer.default.html -->
<!--
Copyright © 1984-2024 by Landon Curt Noll. All Rights Reserved.
You are free to share and adapt this file under the terms of this license:
Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
For more information, see:
https://creativecommons.org/licenses/by-sa/4.0/
-->
<div class="footer">
<div id="copyright"><h3>Copyright &copy; 1984-2024 by Landon Curt Noll:
<a href="https://creativecommons.org/faq/#what-does-some-rights-reserved-mean"
target="_blank"
rel="license noopener noreferrer">Some Rights Reserved</a></h3>
<p>
This work is <b>licensed by Landon Curt Noll</b> under
<b><a href="https://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1"
target="_blank"
rel="license noopener noreferrer"
style="display:inline-block;">CC BY-SA 4.0</a></b>.
<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;"
src="../png/cc.png"
alt="cc inside circle symbol">
<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;"
src="../png/by.png"
alt="person inside circle symbol">
<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;"
src="../png/sa.png"
alt="arrow looping back on itself inside circle symbol"><br>
You should <b>carefully review</b> the
<b><a href="https://creativecommons.org/licenses/by-sa/4.0/legalcode.en"
target="_blank"
rel="license noopener noreferrer">CC BY-SA 4.0 LEGAL CODE</a></b>
before using the licensed material.<br>
You may wish to review the
<b><a href="../license.html"
target="_blank"
rel="license noopener noreferrer">highlights of some of the key features and terms</a></b>
of <b>CC BY-SA 4.0</b>.<br>
</p>
</div>
<div id="coda"><h3>Coda</h3>
<p>
<a href="https://validator.w3.org/nu/?doc=https%3A%2F%2Fwww.ioccc.org%2Fnext%2Fremarks.html" rel="nofollow">Nu HTML check this web page</a><br>
<a href="#top">Jump to top</a> <a href="#content">Jump to Content</a>
</p>
</div>
</div>
<!-- END: this line ends content from: inc/footer.default.html -->
<!-- START: this line starts content from: inc/bottom.default.html -->
</body>
</html>
<!-- END: this line ends content from: inc/bottom.default.html -->
+7 -9
View File
@@ -1,8 +1,10 @@
# Instructions
0. Create an empty file `remarks.md` in your submission directory
(alternatively after reading this file, delete everything in it and rename it
`remarks.md`).
**IMPORTANT**: be **SURE** to read the [IOCCC rules](rules.html) **AND** the
[IOCCC guidelines](guidelines.html)!
0. <a href="remarks.md" download="remarks.md">Download the
markdown form</a> of these remarks into your submission's directory.
1. For help with markdown format please see this [helpful
guide](https://www.markdownguide.org/basic-syntax/).
@@ -11,16 +13,12 @@ guide](https://www.markdownguide.org/basic-syntax/).
guidelines](https://www.ioccc.org/markdown.html). Doing this helps the judges
integrate your remarks into a `README.md`, should you win.
3. After reading this file, write your remarks in your `remarks.md` file (as
mentioned in step 0).
3. Replace the contents of this `remarks.md` (in your submission directory) with
your remarks.
4. When packaging your submission with `mkiocccentry(1)`, make sure that the
`remarks.md` is in the `topdir`.
**IMPORTANT NOTE**: make **SURE** you read the IOCCC
[Rules](https://www.ioccc.org/next/rules.html) and
[Guidelines](https://www.ioccc.org/next/guidelines.html)!
# What should you say?
Please see the