From 7053d5f811b43abbf9d81c103a16b58bde9f74a3 Mon Sep 17 00:00:00 2001
From: Chad Nelson <cnelson@mailbox.org>
Date: Sun, 16 Mar 2025 11:19:04 -0600
Subject: [PATCH] Updated Readme

---
 README.org | 40 +++++++++++++++++++++++++++++++++++-----
 1 file changed, 35 insertions(+), 5 deletions(-)

diff --git a/README.org b/README.org
index 25c104e..d40286d 100644
--- a/README.org
+++ b/README.org
@@ -40,19 +40,18 @@ MSG is an attempt to create a native-like experience for Guix on MacOS, using me
 - qemu
 - autotools
 - guile-next
-  - You can get guile-next from the following homebrew tap: https://github.com/aconchillo/homebrew-guile
 - texinfo
 
 These can be installed by running:
 #+begin_src sh
-brew install autoconf automake libtool wget qemu texinfo guile-next
+brew install autoconf automake libtool wget qemu texinfo msg/apps/guile-next
 #+end_src
 
 
 1. First clone this repository with:
    #+begin_src sh
-   git clone https://pagure.io/MSG/msg-cli.git msg
-   cd msg
+   git clone https://pagure.io/MSG/msg-cli.git
+   cd msg-cli
    #+end_src
 
 2. Build and install the cli using:
@@ -71,7 +70,38 @@ brew install autoconf automake libtool wget qemu texinfo guile-next
    export GUILE_SYSTEM_EXTENSIONS_PATH=$GUILE_SYSTEM_EXTENSIONS_PATH:/usr/local/lib/guile/3.0/extensions
    export PATH=/usr/local/bin:$PATH
    #+end_src
-   
+
+* Contributing
+
+- To work on the package itself, you will want to also make sure that you install guile-hall and guile-config from the msg homebrew tap
+#+begin_src sh
+brew install msg/apps/guile-hall
+#+end_src
+
+- The first recommended thing to do when beginning work on msg-cli is to clean the directory using hall
+  #+begin_src sh
+  hall clean -x
+  #+end_src
+  - This will make sure that all the build files for distribution are cleaned. Also new files must be scanned in using hall before building, and we want to avoid scanning in generated build files
+
+- Adding a new file
+  - After cleaning the build structure, you can add in the new files you would like and run the following:
+    #+begin_src sh
+    hall scan -x
+    #+end_src
+
+- Once you would like to test the application you can generate the build files using:
+  #+begin_src sh
+  hall build -xf
+  #+end_src
+
+- And then install with the autotools dance
+  #+begin_src sh
+  autoreconf -vif && ./configure && make && sudo make install
+  #+end_src
+
+- Make sure to avoid scanning in any autogenerated/build files. Also be sure to run halls clean command before you add a new file, and clean/rebuild the makefiles before pushing to the repo.
+
 * Usage
 - msg machine (command)
   - init: initializes a new MSG instance