diff --git a/README.md b/README.md index 523a48f..5549a17 100644 --- a/README.md +++ b/README.md @@ -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) + + + + # MSG (Mac Subsystem for Guix) + + + + ## 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. + + + # !!!!Currently only compatible with M1/M2 Macs + + + + ## 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-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' - ``` + 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! +**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 +- 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 + + diff --git a/README.md.tmp b/README.md.tmp new file mode 100644 index 0000000..5549a17 --- /dev/null +++ b/README.md.tmp @@ -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) + + + + +# MSG (Mac Subsystem for Guix) + + + + +## Description + +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 + + + + +## 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! + + diff --git a/README.org b/README.org new file mode 100644 index 0000000..25282ee --- /dev/null +++ b/README.org @@ -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