Updated readme to reflect the need for guile-next

This commit is contained in:
Chad Nelson-Toohey 2024-01-08 08:18:23 -07:00
parent 185fb9094b
commit 387c748ea6
2 changed files with 29 additions and 31 deletions

View file

@ -1,19 +1,22 @@
- [Overview](#org6b10202)
- [F.A.Q](#org6fbd87d)
- [Requirements](#orgfb2fee2)
- [Installation](#org69b189c)
- [Usage](#org73e8e02)
# Table of Contents
1. [Overview](#org1eda427)
2. [F.A.Q](#orgfc50bf1)
3. [Requirements](#org8cbb709)
4. [Installation](#orgdce7019)
5. [Usage](#org7b210ca)
<a id="org6b10202"></a>
<a id="org1eda427"></a>
# Overview
MSG is an attempt to create a native-like experience for Guix on MacOS, using methods inspired by others like Podman/Docker/Lima. It uses Qemu with a prebuilt installer image to create a customized local Guix instance (supported on Intel and Apple Silicon based Macs). The base image is pretty barebones and is meant to be customized to your liking. To get a good idea of whats included you can reference the /etc/config.scm file within the built image.
<a id="org6fbd87d"></a>
<a id="orgfc50bf1"></a>
# F.A.Q
@ -28,51 +31,44 @@ MSG is an attempt to create a native-like experience for Guix on MacOS, using me
4. Introduce a MSG Desktop GUI to accompany the cli
<a id="orgfb2fee2"></a>
<a id="org8cbb709"></a>
# Requirements
- wget
- qemu
- autotools
- guile (or guile-next)
- 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:
```sh
brew install autoconf automake libtool wget qemu guile texinfo
```
brew install autoconf automake libtool wget qemu guile texinfo
<a id="org69b189c"></a>
<a id="orgdce7019"></a>
# Installation
1. First clone this repository with:
```sh
git clone https://pagure.io/MSG/msg-cli.git
cd msg-cli
```
git clone https://pagure.io/MSG/msg-cli.git msg
cd msg
2. Build and install the cli using:
```sh
autoreconf -vif && ./configure && make && sudo make install
```
autoreconf -vif && ./configure && make && sudo make install
3. Make sure to add the correct env vars set for guile/MSG (may need to adjust if using the guile homebrew tap)
```sh
export GUILE_LOAD_PATH=/usr/local/share/guile/site/3.0/
export GUILE_LOAD_COMPILED_PATH=/usr/local/lib/guile/3.0/site-ccache/
export GUILE_SYSTEM_EXTENSIONS_PATH=/usr/local/lib/guile/3.0/extensions
export PATH=/usr/local/bin:$PATH
```
export GUILE_LOAD_PATH=/usr/local/share/guile/site/3.0/
export GUILE_LOAD_COMPILED_PATH=/usr/local/lib/guile/3.0/site-ccache/
export GUILE_SYSTEM_EXTENSIONS_PATH=/usr/local/lib/guile/3.0/extensions
export PATH=/usr/local/bin:$PATH
<a id="org73e8e02"></a>
<a id="org7b210ca"></a>
# Usage
@ -82,4 +78,5 @@ brew install autoconf automake libtool wget qemu guile texinfo
- start: starts the initialized MSG instance
- stop: stops the running instance
- msg shell
- Creates an ssh connection to the running instance
- Creates an ssh connection to the running instance

View file

@ -21,7 +21,8 @@ MSG is an attempt to create a native-like experience for Guix on MacOS, using me
- wget
- qemu
- autotools
- guile (or guile-next)
- 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:
@ -32,8 +33,8 @@ brew install autoconf automake libtool wget qemu guile texinfo
* Installation
1. First clone this repository with:
#+begin_src sh
git clone https://pagure.io/MSG/msg-cli.git
cd msg-cli
git clone https://pagure.io/MSG/msg-cli.git msg
cd msg
#+end_src
2. Build and install the cli using: