readme clarification

1 files changed, 21 insertions, 11 deletions

diff --git a/README.adoc b/README.adoc
index e1bd72c..620e8c7 100644
--- a/README.adoc
+++ b/README.adoc
@@ -8,19 +8,31 @@ In short: This does it better. You have precise control over how the end product
 
 == Usage
 
-Requires the `npm` tool.
+Requires the https://nodejs.org/en/download[npm] tool. I also suggest you read the entire page before giving it a go.
+
+=== Preparation
+
+I will assume that you have successfully https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository#_git_cloning[cloned] this https://git-scm.com/download[git] repository and opened a terminal in that directory.
+Next you have to install the needed packages (dependencies) of this project. To do so, just type
+
+```bash
+npm i
+```
+
+=== Generate a PDF file
+
+You can now use the following command to generate a PDF from the current configuration.
 
 ```bash
-npm i # installes packages
-npm run pdf # runs the software and generates a .pdf
+npm run pdf
 ```
 
 === Optional: Generate ICS file
 
-You have the option to generate a calendar file, which you should be able to import into most calendar software. Works with moodle.
+You have the option to generate a calendar file, which you should be able to import into most calendar software. Also works with moodle (but it gets painfully slow).
 
 ```bash
-npm run ics # runs the software and generates a .ics
+npm run ics
 ```
 
 === Optional: Parse UnivIS XML
@@ -37,7 +49,7 @@ npm run parse
 
 Generally, you may edit anything in the `public` directory. The default are how I like it.
 
-To configure the actual displayed information you shoudl edit the `.yaml` file. It should look something like the following, where things like `<THIS>` should be replaced by your text. An example is preconfigured at `public/config.yaml`.
+To configure the actual displayed information you should edit the `.yaml` file. It should look something like the following, where things like `<THIS>` should be replaced by your text. An example is preconfigured at `public/config.yaml`.
 
 Comments (things that are ignored by the software) is everything after a `#` sign. More information on the file format and syntax can be found https://yaml.org/[here].
 
@@ -63,9 +75,8 @@ eintraege:
         - [<WEEKDAY>, <START TIME>, <END TIME>, <ROOM>]
 ```
 
-[NOTE]
-.Please note the following exceptions:
-====
+=== Please note the following
+
 * `START TIME` and `END TIME` should be given in the format `HHhMM` so to say "1:02 PM", you would actually write `13h02`.
 * `LECTURES START` and `LECTURES END` are given in the format `YYYY-MM-DD` so to say "Apr. 23rd, 2024", you would actually write `2024-04-23`.
 * `LECTURES START` has to be a (the first) Monday.
@@ -74,7 +85,7 @@ eintraege:
 * `WEEKDAY` should be given in abbreviated form without a dot. I.e. "Wednesday" becomes `Mi`.
 * The Module `STYLECLASS` is reserved for special stylized cases.
 
-So for example writing 
+So for example writing
 ```yaml
 # ...
   - STYLECLASS:
@@ -86,7 +97,6 @@ would put a blocked area in the pdf, instead of putting an actual entry with the
 
 Under the hood it just takes the word "BLOCK" (which can really be any other) and assigns it to the coresponding times.
 This is then picked up by `public/style.css` (were I have defined what `.block` should look like) and styled accordingly.
-====
 
 == Known issues