Improve documentation

tchoutri · May 24, 2024 · 75a73bc · 75a73bc
1 parent b3f90fc
commit 75a73bc
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,16 @@
-# Confer
+# Confer [![Made with Haskell](https://img.shields.io/badge/Made%20in-Haskell-%235e5086?logo=haskell&style=flat-square)](https://haskell.org)
 
 > The dotfiles manager
 
+## 📖 Documentation
 Read the [Manual](./doc/MANUAL.md) for documentation.
+
+## 📦 Install
+
+No binaries are currently available. See the Build instructions
+
+## 🔧 Build
+
+*Confer* is made in Haskell. To build it from source, use [ghcup](https://www.haskell.org/ghcup/) to install the following toolchains:
+* `cabal` 3.10
+* `ghc` 9.10.1
diff --git a/doc/MANUAL.md b/doc/MANUAL.md
@@ -97,7 +97,7 @@ local server = confer.deploy({
 
 return {
   laptop,
-  server
+  server;
 }
 ```
-Original file line number
+Diff line change
@@ Expand Up / @@ -97,7 +97,7 @@ local server = confer.deploy({ @@
     return {
       laptop,
-      server
+      server;
     }
     ```
@@ Expand Down @@