msg-cli/HACKING
Chad Nelson 55dc43c035 init push
Finished configuring the init/shell commands

Updated readme

Fixed issue with missing /boot/efi directory

Added new config module for setting/retrieving vm configs

Updated machine setup

Fixed issue with missing files

added config to docs section

added x86_64 support

fixed issue with x86_64 update and updated README

Added some content to README

Added markdown export of org file

Updated readme to reflect the need for guile-next

Removed guile from install example

exported changes to md

Updated README

fixed issue with sed compatibility (bsd/gnu)

regenerated readme markdown

Removed readme markdown file for org alternative

Updated project license

updated autocompile to include for now

updated script

updated script

updated script

updated msg script

updated license

updated to test

testing

testing

testing

testing

testing

testing

testing

testing

testing

testing

testing
2025-02-28 10:17:59 -07:00

54 lines
1.3 KiB
Org Mode

# -*- mode: org; coding: utf-8; -*-
#+TITLE: Hacking msg
* Contributing
By far the easiest way to hack on msg is to develop using Guix:
#+BEGIN_SRC bash
# Obtain the source code
cd /path/to/source-code
guix shell -Df guix.scm
# In the new shell, run:
hall build --execute && autoreconf -vif && ./configure && make check
#+END_SRC
You may also want to set your directory as an authorized directory for
`guix shell' so it works without arguments. To do that, simply run
#+BEGIN_SRC bash
echo $(pwd) >> $HOME/.config/guix/shell-authorized-directories
#+END_SRC
You can now hack this project's files to your heart's content, whilst
testing them from your `guix shell' shell.
To try out any scripts in the project you can now use
#+BEGIN_SRC bash
./pre-inst-env scripts/${script-name}
#+END_SRC
If you'd like to tidy the project again, but retain the ability to test the
project from the commandline, simply run:
#+BEGIN_SRC bash
./hall clean --skip "scripts/${script-name},pre-inst-env" --execute
#+END_SRC
** Manual Installation
If you do not yet use Guix, you will have to install this project's
dependencies manually:
- autoconf
- automake
- pkg-config
- texinfo
- guile-hall
Once those dependencies are installed you can run:
#+BEGIN_SRC bash
hall build -x && autoreconf -vif && ./configure && make check
#+END_SRC