Permalink
Browse files

Convert documentation to Markdown.

--HG--
rename : doc/redgreen.html => README.markdown
  • Loading branch information...
1 parent 7743cf3 commit d6387b77d5fdee3a4541b541ea7c220c6054e35b @cpressey cpressey committed Mar 26, 2013
Showing with 53 additions and 143 deletions.
  1. +53 −0 README.markdown
  2. +0 −143 doc/redgreen.html
View
@@ -0,0 +1,53 @@
+REDGREEN
+========
+
+Cellular Automaton
+------------------
+
+REDGREEN is a successor to [RUBE](/projects/rube/). Unlike RUBE,
+REDGREEN is proper cellular automaton (CA): the next state of each cell
+is determined only by its current state and the states of its
+neighbours.
+
+Implementation
+--------------
+
+This implementation of REDGREEN is written in
+[ALPACA](/projects/alpaca/) and compiled to a Perl script using the
+reference ALPACA compiler. As a language for expressing CA's, ALPACA is
+much, much clearer than C (the language in which RUBE was implemented.)
+In fact, the need for a clear description language for RUBE's successor
+was one of the driving forces behind the development of ALPACA. REDGREEN
+is an extremely complex automaton, making full use of ALPACA's "class of
+states" feature.
+
+The REDGREEN Universe
+---------------------
+
+ ---------------- --------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+ Air   Heavy things like water and pebbles fall through air. Light things like smoke and steam rise in air. Air is required for a fire to keep burning.
+ Water **`~`** Heavy solid things like pebbles fall into water. Light things like steam or smoke make rising bubbles in water. Boils to steam when heated, but also puts out open fires. Fish can live a John Conway's Life in water.
+ Fire **`%`** Heavy things like pebbles fall through fire; water puts it out. Requires flammable fuel and air to keep burning, otherwise goes up in smoke. Spreads to adjacent flammables like twigs and heats up adjacent non-flammables like rock.
+ Earth **`#`** Stops things which would otherwise fall from falling. Can be heated up to magma by adjacent fire.
+ Magma **`&`** Heated-up earth, will cool down to earth if no adjacent fire or magma is present. Can boil water.
+ Steam **`s`** From boiling water, rises in air.
+ Smoke **`@`** From fire, rises in air.
+ Bubble **`o`** From air or steam or smoke, rises in water.
+ Fish **`f`** Lives a [John Conway's Life](/projects/alpaca/eg/life/) in water.
+ Pebble **`.`** Falls through air.
+ Two Pebbles **`:`** Two pebbles stacked together, also falls through air.
+ Spark **`*`** An electrical phenomenon living a [WireWorld](/projects/alpaca/eg/wireworld/) existence.
+ Tail **`-`** The trail of a spark.
+ Wire **`=`** Conducts electricity (sparks).
+ Zappy **`z`** Shot off by sparks. Can set flammables on fire.
+ Big Zappy **`Z`** Also shot off by sparks. Can also set flammables on fire.
+ Duct Tape **`D`** Flammable. Things can stick to it. It can unravel.
+ "Oh No" Tape **`O`** Flammable. Duct tape that's unravelling.
+ Twig **`l`** Flammable.
+ Conveyor Left **`<`** Moves twigs, pebbles etc. on top of it to the left.
+ Conveyor Right **`>`** Moves twigs, pebbles etc. on top of it to the right.
+ Randomizer **`?`** Randomly flips the direction of the Conveyor adjacent above it.
+ Torch **`T`** Provides endless fuel for a fire.
+ ---------------- --------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+
View
@@ -1,143 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<!-- encoding: UTF-8 -->
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<title>The REDGREEN Cellular Automaton</title>
- <!-- begin html doc dynamic markup -->
- <script type="text/javascript" src="/contrib/jquery-1.6.4.min.js"></script>
- <script type="text/javascript" src="/scripts/documentation.js"></script>
- <!-- end html doc dynamic markup -->
-</head>
-<body>
-
-<h1>REDGREEN</h1>
-
-<h2>Cellular Automaton</h2>
-
-<p>REDGREEN is a successor to <a href="/projects/rube/">RUBE</a>.
-Unlike RUBE, REDGREEN is proper cellular automaton (CA): the next
-state of each cell is determined only by its current state and
-the states of its neighbours.</p>
-
-<h2>Implementation</h2>
-
-<p>This implementation of REDGREEN is written in <a href="/projects/alpaca/">ALPACA</a>
-and compiled to a Perl script using the reference ALPACA compiler.
-As a language for expressing CA's, ALPACA is much, much clearer than
-C (the language in which RUBE was implemented.) In fact, the need for
-a clear description language for RUBE's successor was one of the driving
-forces behind the development of ALPACA.
-REDGREEN is an extremely complex automaton, making full use of
-ALPACA's "class of states" feature.</p>
-
-<h2>The REDGREEN Universe</h2>
-
-<table>
-<tr><td>Air</td><td> &#160;</td><td>
- Heavy things like water and pebbles fall through air.
- Light things like smoke and steam rise in air.
- Air is required for a fire to keep burning.
-</td></tr>
-
-<tr><td>Water</td><td> <b><tt>~</tt></b></td><td>
- Heavy solid things like pebbles fall into water.
- Light things like steam or smoke make rising bubbles in water.
- Boils to steam when heated, but also puts out open fires.
- Fish can live a John Conway's Life in water.
-</td></tr>
-
-<tr><td>Fire</td><td> <b><tt>%</tt></b></td><td>
- Heavy things like pebbles fall through fire; water puts it out.
- Requires flammable fuel and air to keep burning, otherwise
- goes up in smoke. Spreads to adjacent flammables like twigs
- and heats up adjacent non-flammables like rock.
-</td></tr>
-
-<tr><td>Earth</td><td> <b><tt>#</tt></b></td><td>
- Stops things which would otherwise fall from falling. Can be
- heated up to magma by adjacent fire.
-</td></tr>
-
-
-<tr><td>Magma</td><td> <b><tt>&amp;</tt></b></td><td>
- Heated-up earth, will cool down to earth if no adjacent fire or
- magma is present. Can boil water.
-</td></tr>
-
-<tr><td>Steam</td><td> <b><tt>s</tt></b></td><td>
- From boiling water, rises in air.
-</td></tr>
-
-<tr><td>Smoke</td><td> <b><tt>@</tt></b></td><td>
- From fire, rises in air.
-</td></tr>
-
-<tr><td>Bubble</td><td> <b><tt>o</tt></b></td><td>
- From air or steam or smoke, rises in water.
-</td></tr>
-
-<tr><td>Fish</td><td> <b><tt>f</tt></b></td><td>
- Lives a <a href="/projects/alpaca/eg/life/">John Conway's Life</a> in water.
-</td></tr>
-
-<tr><td>Pebble</td><td> <b><tt>.</tt></b></td><td>
- Falls through air.
-</td></tr>
-
-<tr><td>Two Pebbles</td><td> <b><tt>:</tt></b></td><td>
- Two pebbles stacked together, also falls through air.
-</td></tr>
-
-<tr><td>Spark</td><td> <b><tt>*</tt></b></td><td>
- An electrical phenomenon living a <a href="/projects/alpaca/eg/wireworld/">WireWorld</a> existence.
-</td></tr>
-
-<tr><td>Tail</td><td> <b><tt>-</tt></b></td><td>
- The trail of a spark.
-</td></tr>
-
-<tr><td>Wire</td><td> <b><tt>=</tt></b></td><td>
- Conducts electricity (sparks).
-</td></tr>
-
-<tr><td>Zappy</td><td> <b><tt>z</tt></b></td><td>
- Shot off by sparks. Can set flammables on fire.
-</td></tr>
-
-<tr><td>Big Zappy</td><td> <b><tt>Z</tt></b></td><td>
- Also shot off by sparks. Can also set flammables on fire.
-</td></tr>
-
-<tr><td>Duct Tape</td><td> <b><tt>D</tt></b></td><td>
- Flammable. Things can stick to it. It can unravel.
-</td></tr>
-
-<tr><td>"Oh No" Tape</td><td> <b><tt>O</tt></b></td><td>
- Flammable. Duct tape that's unravelling.
-</td></tr>
-
-<tr><td>Twig</td><td> <b><tt>l</tt></b></td><td>
- Flammable.
-</td></tr>
-
-<tr><td>Conveyor Left</td><td> <b><tt>&lt;</tt></b></td><td>
- Moves twigs, pebbles etc. on top of it to the left.
-</td></tr>
-
-<tr><td>Conveyor Right</td><td> <b><tt>&gt;</tt></b></td><td>
- Moves twigs, pebbles etc. on top of it to the right.
-</td></tr>
-
-<tr><td>Randomizer</td><td> <b><tt>?</tt></b></td><td>
- Randomly flips the direction of the Conveyor adjacent
- above it.
-</td></tr>
-
-<tr><td>Torch</td><td> <b><tt>T</tt></b></td><td>
- Provides endless fuel for a fire.
-</td></tr>
-
-</table>
-
-</body></html>

0 comments on commit d6387b7

Please sign in to comment.