Improve lang readmes, add readme to file gen

languages/befunge93/README.md

@@ -1,3 +1,10 @@
 # Befunge-93
 
-- Interactive input is not supported yet, so currenty division-by-zero throws a runtime error.
+## References
+
+- Esolangs wiki: https://esolangs.org/wiki/Befunge
+
+## Implementation details
+
+- Interactive input is not supported yet, so currently division-by-zero throws a runtime error.
+- `g` and `p` calls that access coordinates outside of the 80x25 grid result in a runtime error.

languages/brainfuck/README.md

@@ -1,21 +1,12 @@
 # Brainfuck
 
-## Allowed symbols
+## References
 
-- `>`: Move the pointer to the right
+- Esolangs wiki: https://esolangs.org/wiki/Brainfuck
-- `<`: Move the pointer to the left
-- `+`: Increment the memory cell at the pointer
-- `-`: Decrement the memory cell at the pointer
-- `.`: Output the character signified by the cell at the pointer
-- `,`: Input a character and store it in the cell at the pointer
-- `[`: Jump past the matching `]` if the cell at the pointer is 0
-- `]`: Jump back to the matching `[` if the cell at the pointer is nonzero
 
-## Memory specifications
+## Implementation details
 
-> These parameters will be configurable when engine configuration is added to the project
+- The tape is semi-unbounded (0, 1, 2 ...)
-
-- For Turing-completeness, the number of cells is kept unbounded.
 - Cell size is 8 bits, and allows values in the range `[-128, 127]`.
 - Value `10` is designated for newlines.
 - The value `0` is returned on reaching `EOF`.

languages/chef/README.md

@@ -1,19 +1,35 @@
 # Chef
 
-- Ingredient names are case-sensitive and must not contain periods.
+## References
+
+- David Morgan-Mar's Chef page: https://www.dangermouse.net/esoteric/chef.html
+
+## Implementation details
+
+- Ingredient names are case-sensitive and must contain only letters and spaces.
+
 - Auxiliary recipe names are case-sensitive. If the recipe title is `Chocolate Sauce`, calling instruction must be `Serve with Chocolate Sauce` and not `Serve with chocolate sauce`.
+
 - Each method instruction must end with a period.
-- The method section can be spread across multiple lines.
+
-- A single method instruction cannot roll over to the next line.
+- Method instructions can be located on separate lines, the same line or a mix of both. The following is a valid Chef recipe method:
+
+  ```
+  Put salt into the mixing bowl. Mix well.
+  Fold sugar into the mixing bowl. Clean the mixing bowl.
+  ```
+
+  Note that a single method instruction cannot roll over to the next line, though.
+
 - The Chef language involves usage of present and past forms of verbs:
   ```
-  Blend the sugar
+  Blend the sugar.
   <other instructions>
-  Shake the mixture until blended
+  Shake the mixture until blended.
   ```
   The Esolang Park interpreter cannot convert verbs between the two forms, so we adopt the following convention: the past form of the verb is the same as the present form of the verb. So the above example must be changed to the following for Esolang Park:
   ```
-  Blend the sugar
+  Blend the sugar.
   <other instructions>
-  Shake the mixture until blend
+  Shake the mixture until blend.
   ```

languages/deadfish/README.md

@@ -1,8 +1,9 @@
 # Deadfish
 
-## Allowed symbols
+## References
 
-- `i`: Increment value by 1
+- Esolangs wiki: https://esolangs.org/wiki/Deadfish
-- `d`: Decrement value by 1
+
-- `s`: Square the value
+## Implementation details
-- `o`: Output the value
+
+- The value is unbounded, but is reset to `0` whenever it equals `-1` or `256`.

scripts/add-new-language.js

@@ -39,7 +39,7 @@ const copyFile = (src, dest) => {
 };
 
 {
-  // Copy language provider template files
+  // Copy language provider template files (except the README)
   ["index.ts", "common.ts", "runtime.ts", "engine.ts", "renderer.tsx"].forEach(
     (filename) => {
       const srcPath = path.resolve(__dirname, `new-lang-template/${filename}`);
@@ -49,6 +49,15 @@ const copyFile = (src, dest) => {
   );
 }
 
+{
+  // Copy the language provider README file
+  const src = path.resolve(__dirname, "./new-lang-template/README.md");
+  const dest = path.resolve(dir, "README.md");
+  const contents = fs.readFileSync(src).toString();
+  const finalContents = contents.replace("$LANG_NAME", langName);
+  fs.writeFileSync(dest, finalContents);
+}
+
 {
   // Generate Next.js page
   const src = path.resolve(__dirname, "./new-lang-template/ide-page.tsx");

scripts/new-lang-template/README.md

@@ -0,0 +1,5 @@
+# $LANG_NAME
+
+## References
+
+## Implementation details