From 7c6e3be25c6bf9353d4b39bb3960ecbd39edb3f8 Mon Sep 17 00:00:00 2001 From: Phil Bajsicki Date: Tue, 22 Aug 2023 21:50:54 +0200 Subject: [PATCH] Cleanup in the README, clarifying the pseudocode example blocks. --- README.org | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.org b/README.org index fe5240f..4e292ef 100644 --- a/README.org +++ b/README.org @@ -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: +#+name: Lua code generating a .csv file containing all available recipes. #+begin_src lua :tangle no /c 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. *** For each product, create a templated section Ideally we'd end up with Something like: - +#+name: Example structure of a section of the output file. #+begin_example ,* product ,** direct inputs @@ -87,10 +88,11 @@ For each line: This would look something like: - #+begin_example - (raw-ingredients iron-gear-wheel iron-plate 2) - (raw-ingredients yellow-belt iron-plate 1) - #+end_example +#+name: Example call to the raw-ingredients function. +#+begin_example +(raw-ingredients iron-gear-wheel iron-plate 2) +(raw-ingredients yellow-belt iron-plate 1) +#+end_example 3. ~(raw-ingredients (product item number))~: 1. Store in variables for clarity: