matlab mark

Author: ingun37

README.md

@@ -1,4 +1,6 @@
-# Build MacOS
+This is a Haskell script that transforms the resources from [ingun37/answers-db](https://github.com/ingun37/answers-db) into the static assets for the website [ingun37/answers](https://github.com/ingun37/answers). The nix build cache is pushed to the `inguncache` Cachix in the CI/CD here, and pulled from the CI/CD of the **answers** web app. Check out the github workflow files of both projects for the details.
+
+# Build manually on MacOS
 
 ```sh
 # for building gitlib packages 
@@ -12,10 +14,16 @@ ln -s $(brew --prefix openssl@3)/3.5.2 /usr/local/opt/openssl
 echo "export PKG_CONFIG_PATH=\"$(brew --prefix)/opt/icu4c/lib/pkgconfig\"" >> ~/.zprofile
 ```
 
+## Build
 ```sh
 cabal build
 ```
 
+## Run Unit test
+```sh
+cabal test
+```
+
 # Data flow
 
 ```mermaid
@@ -38,14 +46,16 @@ flowchart LR
 
 # CI/CD
 
+## Update gitlib sha1
+
 Check the sha1 of gitlib like this
 
 ```sh
-nix-shell -p nix-prefetch-git 
+nix-shell -p nix-prefetch-git
 nix-prefetch-git https://github.com/jwiegley/gitlib.git bf256617179d853bdbc12e9283b3f570ebb9d9d7 --fetch-submodules
 ```
 
-Output is like
+Output will look like this
 
 ```
 git revision is bf256617179d853bdbc12e9283b3f570ebb9d9d7
@@ -69,4 +79,4 @@ hash is 13k3aymqwzpcijnjjka820nv6rkgakzbvh13glw98p1c4yhqwcbf
 }
 ```
 
-Use the "sha256" for the `--sha256` field in the `cabal.project`.
+Use the "sha256" for the `--sha256` field in the `cabal.project`.

answers-script.cabal

@@ -157,4 +157,4 @@ test-suite answers-script-test
         attoparsec,
         cmark,
         cmark-lens,
-        directory
+        directory

app/Main.hs

@@ -87,4 +87,4 @@ main =
               <> progDesc "Collection of utility functions for the Answers web app"
               <> header "Collection of utility functions for the Answers web app"
           )
-      )
+      )

cabal.project

@@ -24,4 +24,4 @@ source-repository-package
 source-repository-package
     type: git
     location: https://github.com/ingun37/cmark-lens.git
-    tag: 4456f10deccb61419ce28811db448c266931190f
+    tag: 4456f10deccb61419ce28811db448c266931190f

test/Main.hs

@@ -58,4 +58,4 @@ matlab =
     b <- DT.readDirectoryWith TIO.readFile ("test" F.</> "matlab-expect")
     let b' = b ^.DT._dirTree
     let b'' = DT.flattenDir (set DT._name "" b')
-    zipWithM_ shouldBe a'' b''
+    zipWithM_ shouldBe a'' b''