Updated readme

This commit is contained in:
Chad Nelson 2023-09-16 16:10:25 -06:00
parent bccff31856
commit 519edf5e90
3 changed files with 141 additions and 18 deletions

View file

@ -1,31 +1,55 @@
# Table of Contents
1. [MSG (Mac Subsystem for Guix)](#msg-mac-subsystem-for-guix)
1. [Description](#description)
2. [!!!!Currently only compatible with M1/M2 Macs](#currently-only-compatible-with-m1m2-macs)
1. [README (WIP)](#readme-wip)
<a id="msg-mac-subsystem-for-guix"></a>
# MSG (Mac Subsystem for Guix) # MSG (Mac Subsystem for Guix)
<a id="description"></a>
## Description ## Description
MSG is an attempt to create a native-like experience for GUIX on MacOS, using methods inspired by others like Podman/Docker/Lima.
MSG is an attempt to create a native-like experience for GUIX on MacOS,
using methods inspired by others like Podman/Docker/Lima.
<a id="currently-only-compatible-with-m1m2-macs"></a>
# !!!!Currently only compatible with M1/M2 Macs # !!!!Currently only compatible with M1/M2 Macs
<a id="readme-wip"></a>
## README (WIP) ## README (WIP)
**REQUIREMENTS** - xquartz (if you want to run graphical applications) -
You also must go to Xquartz->Settings->Security->Enable 'Allow
connections from network clients' - Add the following to your shellrc
file (~/.bashrc, ~/.zshrc, etc)
**REQUIREMENTS**
- xquartz (if you want to run graphical applications)
- You also must go to Xquartz->Settings->Security->Enable 'Allow connections from network clients'
- Add the following to your shellrc file (~/.bashrc, ~/.zshrc, etc)
- ```
alias guix="ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local 'guix'" alias guix="ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local 'guix'"
alias guix-shell="ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local" alias guix-shell"ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local"
alias guix-env='f(){ ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local /home/admin/.guix-profile /bin/$@; unset -f f; }; f' alias guix-env='f(){ ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local /home/admin/.guix-profile /bin/$@; unset -f f; }; f'
alias guix-app='f(){ ssh -X -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local /home/admin/.guix-profile/bin/$@; unset -f f; }; f' alias guix-app='f(){ ssh -X -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local /home/admin/.guix-profile/bin/$@; unset -f f; }; f'
```
**INSTRUCTIONS** **INSTRUCTIONS** - Drag the Guix.app file into your Applications directory
- Drag the Guix.app file into your Applications directory and run! and run!
**Available Commands (after adding bashrc/zshrc options)** **Available Commands (after adding bashrc/zshrc options)**
* guix : A straight passthrough to the guix application - guix : A straight passthrough to the guix application
* guix-shell: Connect to the vm over ssh - guix-shell: Connect to the vm over ssh
* guix-env : Can be used to pass cli commands interactively - guix-env : Can be used to pass cli commands interactively
* guix-app : Used to passthrough X11 applications from the vm to macos using xquartz - guix-app : Used to passthrough X11 applications from the vm to macos
using xquartz
If you would like to discuss or ask questions, join us on our Discord! If you would like to discuss or ask questions, join us on our Discord!
https://discord.gg/WSceSUhs6t <https://discord.gg/WSceSUhs6t>

55
README.md.tmp Normal file
View file

@ -0,0 +1,55 @@
# Table of Contents
1. [MSG (Mac Subsystem for Guix)](#msg-mac-subsystem-for-guix)
1. [Description](#description)
2. [!!!!Currently only compatible with M1/M2 Macs](#currently-only-compatible-with-m1m2-macs)
1. [README (WIP)](#readme-wip)
<a id="msg-mac-subsystem-for-guix"></a>
# MSG (Mac Subsystem for Guix)
<a id="description"></a>
## Description
MSG is an attempt to create a native-like experience for GUIX on MacOS,
using methods inspired by others like Podman/Docker/Lima.
<a id="currently-only-compatible-with-m1m2-macs"></a>
# !!!!Currently only compatible with M1/M2 Macs
<a id="readme-wip"></a>
## README (WIP)
**REQUIREMENTS** - xquartz (if you want to run graphical applications) -
You also must go to Xquartz->Settings->Security->Enable 'Allow
connections from network clients' - Add the following to your shellrc
file (~/.bashrc, ~/.zshrc, etc)
alias guix="ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local 'guix'"
alias guix-shell"ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local"
alias guix-env='f(){ ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local /home/admin/.guix-profile /bin/$@; unset -f f; }; f'
alias guix-app='f(){ ssh -X -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local /home/admin/.guix-profile/bin/$@; unset -f f; }; f'
**INSTRUCTIONS** - Drag the Guix.app file into your Applications directory
and run!
**Available Commands (after adding bashrc/zshrc options)**
- guix : A straight passthrough to the guix application
- guix-shell: Connect to the vm over ssh
- guix-env : Can be used to pass cli commands interactively
- guix-app : Used to passthrough X11 applications from the vm to macos
using xquartz
If you would like to discuss or ask questions, join us on our Discord!
<https://discord.gg/WSceSUhs6t>

44
README.org Normal file
View file

@ -0,0 +1,44 @@
* MSG (Mac Subsystem for Guix)
:PROPERTIES:
:CUSTOM_ID: msg-mac-subsystem-for-guix
:END:
** Description
:PROPERTIES:
:CUSTOM_ID: description
:END:
MSG is an attempt to create a native-like experience for GUIX on MacOS,
using methods inspired by others like Podman/Docker/Lima.
* !!!!Currently only compatible with M1/M2 Macs
:PROPERTIES:
:CUSTOM_ID: currently-only-compatible-with-m1m2-macs
:END:
** README (WIP)
:PROPERTIES:
:CUSTOM_ID: readme-wip
:END:
*REQUIREMENTS* - xquartz (if you want to run graphical applications) -
You also must go to Xquartz->Settings->Security->Enable 'Allow
connections from network clients' - Add the following to your shellrc
file (~/.bashrc, ~/.zshrc, etc)
#+begin_example
alias guix="ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local 'guix'"
alias guix-shell"ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local"
alias guix-env='f(){ ssh -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local /home/admin/.guix-profile /bin/$@; unset -f f; }; f'
alias guix-app='f(){ ssh -X -i $HOME/.guix/ssh-cert/msg_rsa admin@msg.local /home/admin/.guix-profile/bin/$@; unset -f f; }; f'
#+end_example
*INSTRUCTIONS* - Drag the Guix.app file into your Applications directory
and run!
*Available Commands (after adding bashrc/zshrc options)*
- guix : A straight passthrough to the guix application
- guix-shell: Connect to the vm over ssh
- guix-env : Can be used to pass cli commands interactively
- guix-app : Used to passthrough X11 applications from the vm to macos
using xquartz
If you would like to discuss or ask questions, join us on our Discord!
https://discord.gg/WSceSUhs6t