Add cabal update to instructions

rzk-lang · Oct 7, 2023 · 3aa8fd3 · 3aa8fd3
1 parent 5fd1a66
commit 3aa8fd3
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ However, for larger and multi-file formalisations you should install a version o
 - You can install the latest "stable" version of `rzk` from Hackage:
 
   ```sh
+  cabal update
   cabal install rzk
   ```
 

diff --git a/docs/docs/getting-started/install.md b/docs/docs/getting-started/install.md
@@ -7,26 +7,26 @@ These instructions will walk you through setting up Rzk using the "basic" setup
 1. Install [VS Code](https://code.visualstudio.com/).
 2. Launch VS Code and install the [`rzk` extension](https://marketplace.visualstudio.com/items?itemName=NikolaiKudasovfizruk.rzk-1-experimental-highlighting).
 3. Create a new file using "File > New Text File" (<kbd>Ctrl+N</kbd>). Click the `Select a language` prompt, type in `rzk`, and select "Literate Rzk Markdown".
-  ![VS Code rzk language selector.](../../assets/images/vscode-rzk-select-language.png)
+   ![VS Code rzk language selector.](../../assets/images/vscode-rzk-select-language.png)
 4. You should see the following popup:
-  ![VS Code rzk install prompt.](../../assets/images/vscode-rzk-install-prompt.png)
+   ![VS Code rzk install prompt.](../../assets/images/vscode-rzk-install-prompt.png)
 5. Click "Yes" button.
 6. While it is installing, you can paste the following literate Rzk program into the new file:
 
-    ````markdown
-    # Sample literate Rzk markdown
+   ````markdown
+   # Sample literate Rzk markdown
 
-    ```rzk
-    #lang rzk-1
-    
-    #define id (A : U)
-      : A -> A
-      := \ x -> x
-    ```
-    ````
+   ```rzk
+   #lang rzk-1
+
+   #define id (A : U)
+     : A -> A
+     := \ x -> x
+   ```
+   ````
 
 7. When the installation is done you should see the following popup:
-  ![VS Code rzk reload prompt.](../../assets/images/vscode-rzk-install-success-reload-prompt.png)
+   ![VS Code rzk reload prompt.](../../assets/images/vscode-rzk-install-success-reload-prompt.png)
 8. Click "Reload button".
 9. Save your file as `example.rzk.md`.
 10. Open local Terminal (<kbd>Ctrl+`</kbd>).
@@ -84,6 +84,7 @@ stack build && stack install
 To build and install with `cabal-install` from Hackage:
 
 ```sh
+cabal v2-update
 cabal v2-install rzk
 ```
 
@@ -99,4 +100,5 @@ cabal v2-build && cabal v2-install
 ### Nix
 
 !!! warning "Work-in-progress"
+
     To be done.