Updated Readme

This commit is contained in:
Chad Nelson 2025-03-16 11:19:04 -06:00
parent 79c6dd4ef5
commit 7053d5f811

View file

@ -40,19 +40,18 @@ MSG is an attempt to create a native-like experience for Guix on MacOS, using me
- qemu - qemu
- autotools - autotools
- guile-next - guile-next
- You can get guile-next from the following homebrew tap: https://github.com/aconchillo/homebrew-guile
- texinfo - texinfo
These can be installed by running: These can be installed by running:
#+begin_src sh #+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 #+end_src
1. First clone this repository with: 1. First clone this repository with:
#+begin_src sh #+begin_src sh
git clone https://pagure.io/MSG/msg-cli.git msg git clone https://pagure.io/MSG/msg-cli.git
cd msg cd msg-cli
#+end_src #+end_src
2. Build and install the cli using: 2. Build and install the cli using:
@ -72,6 +71,37 @@ brew install autoconf automake libtool wget qemu texinfo guile-next
export PATH=/usr/local/bin:$PATH export PATH=/usr/local/bin:$PATH
#+end_src #+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 * Usage
- msg machine (command) - msg machine (command)
- init: initializes a new MSG instance - init: initializes a new MSG instance