Cleanup in the README, clarifying the pseudocode example blocks.

This commit is contained in:
Phil Bajsicki 2023-08-22 21:50:54 +02:00
parent 6c020982f4
commit 7c6e3be25c

View file

@ -6,6 +6,7 @@ This is a simple Raku script which generates an analysis of each recipe into its
The .csv files used as input are generated in Factorio, by loading a new game with only ~base~ and your chosen mod enabled, and running the following Lua code: The .csv files used as input are generated in Factorio, by loading a new game with only ~base~ and your chosen mod enabled, and running the following Lua code:
#+name: Lua code generating a .csv file containing all available recipes.
#+begin_src lua :tangle no #+begin_src lua :tangle no
/c /c
local whitelist = {} local whitelist = {}
@ -61,7 +62,7 @@ That's the first column in the .csv file.
Read first column of the csv file and insert it into the .org (output) file. Read first column of the csv file and insert it into the .org (output) file.
*** For each product, create a templated section *** For each product, create a templated section
Ideally we'd end up with Something like: Ideally we'd end up with Something like:
#+name: Example structure of a section of the output file.
#+begin_example #+begin_example
,* product ,* product
,** direct inputs ,** direct inputs
@ -87,10 +88,11 @@ For each line:
This would look something like: This would look something like:
#+begin_example #+name: Example call to the raw-ingredients function.
(raw-ingredients iron-gear-wheel iron-plate 2) #+begin_example
(raw-ingredients yellow-belt iron-plate 1) (raw-ingredients iron-gear-wheel iron-plate 2)
#+end_example (raw-ingredients yellow-belt iron-plate 1)
#+end_example
3. ~(raw-ingredients (product item number))~: 3. ~(raw-ingredients (product item number))~:
1. Store in variables for clarity: 1. Store in variables for clarity: