Improve lang readmes, add readme to file gen

This commit is contained in:
Nilay Majorwar
2022-01-31 16:38:44 +05:30
parent ee64b73d28
commit e0a5f431d8
6 changed files with 56 additions and 27 deletions

View File

@ -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.
```