From dcd33ae8d5556f13c4e8632d5553e48c8bb578f6 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Wed, 20 Mar 2024 15:32:31 -0700 Subject: [PATCH] changes to improve the general format of markdown files --- 1989/jar.1/README.md | 1 - 1989/ovdluhe/README.md | 1 + 1990/baruch/README.md | 1 - 1990/theorem/README.md | 2 -- 1992/albert/README.md | 1 + 1992/ant/README.md | 1 - 1992/buzzard.2/README.md | 1 + 1993/cmills/README.md | 1 - 1993/ejb/README.md | 1 - 1994/tvr/README.md | 2 +- 1994/tvr/index.html | 2 +- 1994/westley/README.md | 7 +++---- 1994/westley/index.html | 6 +++--- 1995/cdua/README.md | 1 - 1995/leo/README.md | 1 - 1996/eldby/README.md | 1 - 1998/chaos/README.md | 1 - 1998/dlowe/README.md | 1 - 2004/gavare/README.md | 2 +- 2004/gavare/index.html | 2 +- 2006/borsanyi/README.md | 1 - 2006/monge/README.md | 1 - 2011/richards/README.md | 1 + CODE_OF_CONDUCT.md | 10 ++++++++++ tmp/format-headers.sh | 2 +- 25 files changed, 25 insertions(+), 26 deletions(-) diff --git a/1989/jar.1/README.md b/1989/jar.1/README.md index 7ee661c98..06a803785 100644 --- a/1989/jar.1/README.md +++ b/1989/jar.1/README.md @@ -33,7 +33,6 @@ make clobber alt ### Alternate use: - ```sh ./jar.1.alt ``` diff --git a/1989/ovdluhe/README.md b/1989/ovdluhe/README.md index 4249aa5b8..1149825b6 100644 --- a/1989/ovdluhe/README.md +++ b/1989/ovdluhe/README.md @@ -50,6 +50,7 @@ program to fail and a negative value will cause a compilation error. ./ovdluhe.alt ``` + ### Alternate try: ```sh diff --git a/1990/baruch/README.md b/1990/baruch/README.md index 71a05aebc..6eade6ccd 100644 --- a/1990/baruch/README.md +++ b/1990/baruch/README.md @@ -19,7 +19,6 @@ STATUS: INABIAF - please **DO NOT** fix For more detailed information see [1990 baruch bugs](../../bugs.html#1990_baruch). - ## To use: ```sh diff --git a/1990/theorem/README.md b/1990/theorem/README.md index db41846cf..536e612ab 100644 --- a/1990/theorem/README.md +++ b/1990/theorem/README.md @@ -40,8 +40,6 @@ y1 - initial value (y(x1) == y1) ``` - - ## Judges' remarks: The program's source implements four functions, all from the diff --git a/1992/albert/README.md b/1992/albert/README.md index 9f8fe3cc1..788a66a37 100644 --- a/1992/albert/README.md +++ b/1992/albert/README.md @@ -80,6 +80,7 @@ Use `albert.alt` as you would `albert` above. ./try.alt.sh ``` + ## Judges' remarks: We were impressed with the speed at which it was able to factor diff --git a/1992/ant/README.md b/1992/ant/README.md index b09e41b79..28c331e5d 100644 --- a/1992/ant/README.md +++ b/1992/ant/README.md @@ -18,7 +18,6 @@ where `Makefile` is a Makefile to use and `rule` is an optional rule to use. ## Try: - ```sh ./try.sh ``` diff --git a/1992/buzzard.2/README.md b/1992/buzzard.2/README.md index 75911dcf7..ab021d685 100644 --- a/1992/buzzard.2/README.md +++ b/1992/buzzard.2/README.md @@ -79,6 +79,7 @@ Use `buzzard.2.alt` as you would `buzzard.2` above. ./try.alt.sh ``` + ## Judges' remarks: Have fun! diff --git a/1993/cmills/README.md b/1993/cmills/README.md index 17c30961b..d1d6a47fb 100644 --- a/1993/cmills/README.md +++ b/1993/cmills/README.md @@ -21,7 +21,6 @@ make clobber SLEEP=200 alt ``` - ### Bugs and (Mis)features: The current status of this entry is: diff --git a/1993/ejb/README.md b/1993/ejb/README.md index ce572fd5b..1a6e04d46 100644 --- a/1993/ejb/README.md +++ b/1993/ejb/README.md @@ -20,7 +20,6 @@ level a value from -128 to 127 ## Try: - ```sh ./try.sh ``` diff --git a/1994/tvr/README.md b/1994/tvr/README.md index 67e045aac..8b0f260a4 100644 --- a/1994/tvr/README.md +++ b/1994/tvr/README.md @@ -59,7 +59,7 @@ where `altmode` `1` - `4` correspond to mode `0` - `3` in the original entry and `altmode 0` calculates Mandelbrot/Julian sets correctly. -## Alternate try: +### Alternate try: ```sh ./try.alt.color.sh # for colour displays diff --git a/1994/tvr/index.html b/1994/tvr/index.html index 47840a78f..4f59a8404 100644 --- a/1994/tvr/index.html +++ b/1994/tvr/index.html @@ -161,7 +161,7 @@ code below.

./tvr.alt altmode screensize/2 < colormapfile

where altmode 1 - 4 correspond to mode 0 - 3 in the original entry and altmode 0 calculates Mandelbrot/Julian sets correctly.

-

Alternate try:

+

Alternate try:

./try.alt.color.sh          # for colour displays
 ./try.alt.bw.sh         # for Black & White displays

Judges’ remarks:

diff --git a/1994/westley/README.md b/1994/westley/README.md index 32b9a9c6b..692c4b7e6 100644 --- a/1994/westley/README.md +++ b/1994/westley/README.md @@ -15,7 +15,6 @@ see [Original code](#original-code) below. ## To use: - ```sh ./westley.alt ``` @@ -35,7 +34,7 @@ get a better idea or see below in the [Try](#try) section for running the game from start to finish. -### Try: +## Try: For something more interesting try compiling it with different `cc -D` arguments and then run the program each time. For example: @@ -76,7 +75,7 @@ better idea or see below in the [Original try](#original-try) section for running the game from start to finish. -## Original use: +### Original use: There is no running of this program directly as it is supposed to fail to compile: the purpose of the game is to escape the dungeon but depending on the @@ -91,7 +90,7 @@ you do not run this program as it will not compile: instead it will be compiler error messages; there is no running the program. -## Original try: +### Original try: For something more interesting try compiling it with different `cc -D` arguments: diff --git a/1994/westley/index.html b/1994/westley/index.html index 9afedf755..26ee1a365 100644 --- a/1994/westley/index.html +++ b/1994/westley/index.html @@ -160,7 +160,7 @@ invocations specified. That means with the right compiler invocation you ca message you get. You might wish to look at the source code to get a better idea or see below in the Try section for running the game from start to finish.

-

Try:

+

Try:

For something more interesting try compiling it with different cc -D arguments and then run the program each time. For example:

cc -Describe -Door westley.alt.c -o westley.alt && ./westley.alt
@@ -181,7 +181,7 @@ reason that we recommend you try it first.

 message you get. You might wish to look at the source code to get a
 better idea or see below in the Original try section for
 running the game from start to finish.

-
Original use:

+
Original use:

 
There is no running of this program directly as it is supposed to fail to
 compile: the purpose of the game is to escape the dungeon but depending on the
 compiler line you will get a different message (as compiler errors due to
@@ -192,7 +192,7 @@ invocations specified. That means with the right compiler invocation you ca
 ‘win’ the game on the first go. But unlike the alternate code,
 you do not run this program as it will not compile: instead it will be compiler
 error messages; there is no running the program.

-
Original try:

+
Original try:

 
For something more interesting try compiling it with different cc -D
 arguments:

 
cc -Describe -Door westley.c
diff --git a/1995/cdua/README.md b/1995/cdua/README.md
index 17a62bd82..195c9e323 100644
--- a/1995/cdua/README.md
+++ b/1995/cdua/README.md
@@ -35,7 +35,6 @@ For more detailed information see [1995 cdua bugs](../../bugs.html#1995_cdua).
 
 ## Try:
 
-
 ```sh
 make SLEEP=1500 clobber alt
 
diff --git a/1995/leo/README.md b/1995/leo/README.md
index 50d24eab0..4d84a6175 100644
--- a/1995/leo/README.md
+++ b/1995/leo/README.md
@@ -16,7 +16,6 @@ STATUS: known bug - please help us fix
 For more detailed information see [1995 leo bugs](../../bugs.html#1995_leo).
 
 
-
 ## To use:
 
 ```sh
diff --git a/1996/eldby/README.md b/1996/eldby/README.md
index db0bc3a89..74d0218cd 100644
--- a/1996/eldby/README.md
+++ b/1996/eldby/README.md
@@ -41,7 +41,6 @@ This version is the original which has no sleep time in between updates.
 
 ### Original build:
 
-
 ```sh
 make all
 ```
diff --git a/1998/chaos/README.md b/1998/chaos/README.md
index 9e419cf4e..c2a526e8e 100644
--- a/1998/chaos/README.md
+++ b/1998/chaos/README.md
@@ -23,7 +23,6 @@ make chaos_nohalf
 
 ## Try:
 
-
 ```sh
 ./try.sh
 ```
diff --git a/1998/dlowe/README.md b/1998/dlowe/README.md
index e4e7f5040..cf1d274bb 100644
--- a/1998/dlowe/README.md
+++ b/1998/dlowe/README.md
@@ -78,7 +78,6 @@ What's the difference between this and `dlowe`?
 Did you spot the Easter egg there?
 
 
-
 ## Judges' remarks:
 
 Why could this this entry be considered a utility?  Well because it
diff --git a/2004/gavare/README.md b/2004/gavare/README.md
index 424facc7c..10e0d6e92 100644
--- a/2004/gavare/README.md
+++ b/2004/gavare/README.md
@@ -24,7 +24,7 @@ convert ioccc_ray.ppm ioccc_ray.jpg
 and then view `ioccc_ray.jpg` in a graphics viewer, editor or web browser.
 
 
-### Try:
+## Try:
 
 If you have `xv(1)` you can do:
 
diff --git a/2004/gavare/index.html b/2004/gavare/index.html
index 80a18676e..9fdd2cb3c 100644
--- a/2004/gavare/index.html
+++ b/2004/gavare/index.html
@@ -149,7 +149,7 @@ for more details.

 if you have ImageMagick installed, you can convert it to a jpeg:

 
convert ioccc_ray.ppm ioccc_ray.jpg

 
and then view ioccc_ray.jpg in a graphics viewer, editor or web browser.

-
Try:

+
Try:

 
If you have xv(1) you can do:

 
./gavare | xv -

 
to not worry about writing it to a file and just viewing the image it creates.

diff --git a/2006/borsanyi/README.md b/2006/borsanyi/README.md
index 8c90ab5eb..b2fc78c2a 100644
--- a/2006/borsanyi/README.md
+++ b/2006/borsanyi/README.md
@@ -34,7 +34,6 @@ We recommend you input for the filename `example.gif` and for the string
 a loop until you answer that you do not wish to make another.
 
 
-
 ## Judges' remarks:
 
 This entry uses a very user-friendly representation of the font
diff --git a/2006/monge/README.md b/2006/monge/README.md
index d37c29099..5819a2df6 100644
--- a/2006/monge/README.md
+++ b/2006/monge/README.md
@@ -38,7 +38,6 @@ Incorrect formulas will ungracefully crash the program.
 ```
 
 
-
 ## Alternate code:
 
 This alternate code lets you specify the width and height of the image as well
diff --git a/2011/richards/README.md b/2011/richards/README.md
index 4d6fe06d2..b6ba3af02 100644
--- a/2011/richards/README.md
+++ b/2011/richards/README.md
@@ -4,6 +4,7 @@
 make
 ```
 
+
 ### Bugs and (Mis)features:
 
 The current status of this entry is:
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 508ecffc6..1fb930c43 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -1,5 +1,6 @@
 # Contributor Covenant Code of Conduct
 
+
 ## Our Pledge
 
 We as members, contributors, and leaders pledge to make participation in our
@@ -12,6 +13,7 @@ and orientation.
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 
+
 ## Our Standards
 
 Examples of behavior that contributes to a positive environment for our
@@ -36,6 +38,7 @@ Examples of unacceptable behavior include:
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
+
 ## Enforcement Responsibilities
 
 Community leaders are responsible for clarifying and enforcing our standards of
@@ -56,6 +59,7 @@ Examples of representing our community include using an official e-mail address,
 posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 
+
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
@@ -66,11 +70,13 @@ All complaints will be reviewed and investigated promptly and fairly.
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
 
+
 ## Enforcement Guidelines
 
 Community leaders will follow these Community Impact Guidelines in determining
 the consequences for any action they deem in violation of this Code of Conduct:
 
+
 ### 1. Correction
 
 **Community Impact**: Use of inappropriate language or other behavior deemed
@@ -80,6 +86,7 @@ unprofessional or unwelcome in the community.
 clarity around the nature of the violation and an explanation of why the
 behavior was inappropriate. A public apology may be requested.
 
+
 ### 2. Warning
 
 **Community Impact**: A violation through a single incident or series
@@ -92,6 +99,7 @@ includes avoiding interactions in community spaces as well as external channels
 like social media. Violating these terms may lead to a temporary or
 permanent ban.
 
+
 ### 3. Temporary Ban
 
 **Community Impact**: A serious violation of community standards, including
@@ -103,6 +111,7 @@ private interaction with the people involved, including unsolicited interaction
 with those enforcing the Code of Conduct, is allowed during this period.
 Violating these terms may lead to a permanent ban.
 
+
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
@@ -112,6 +121,7 @@ individual, or aggression toward or disparagement of classes of individuals.
 **Consequence**: A permanent ban from any sort of public interaction within
 the community.
 
+
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
diff --git a/tmp/format-headers.sh b/tmp/format-headers.sh
index c7724a07a..5b7ec7d35 100755
--- a/tmp/format-headers.sh
+++ b/tmp/format-headers.sh
@@ -13,7 +13,7 @@ for i in $(git ls-files '[0-9][0-9][0-9][0-9]/*README.md'); do
     perl -0777 -p -i -e 's/([^\n]\n)\n*##*[[:space:]]*(To build):?\n\n*([^\n])?/$1\n\n## $2:\n\n$3/' "$i"
     perl -0777 -p -i -e 's/([^\n]\n)\n*##*[[:space:]]*(Bugs and \(Mis\)features):?\n\n*([^\n])?/$1\n\n### $2:\n\n$3/' "$i"
     perl -0777 -p -i -e 's/([^\n]\n)\n*##*[[:space:]]*(To use):?\n\n*([^\n])?/$1\n\n## $2:\n\n$3/' "$i"
-    perl -0777 -p -i -e 's/([^\n]\n)\n*##*[[:space:]]*(Try):?\n\n*([^\n])?/$1\n\n### $2:\n\n$3/' "$i"
+    perl -0777 -p -i -e 's/([^\n]\n)\n*##*[[:space:]]*(Try):?\n\n*([^\n])?/$1\n\n## $2:\n\n$3/' "$i"
     perl -0777 -p -i -e 's/([^\n]\n)\n*##*[[:space:]]*(Original code):?\n\n*([^\n])?/$1\n\n## $2:\n\n$3/' "$i"
     perl -0777 -p -i -e 's/([^\n]\n)\n*##*[[:space:]]*(Original build):?\n\n*([^\n])?/$1\n\n### $2:\n\n$3/' "$i"
     perl -0777 -p -i -e 's/([^\n]\n)\n*##*[[:space:]]*(Original try):?\n\n*([^\n])?/$1\n\n### $2:\n\n$3/' "$i"