Let's begin!

1 files changed, 39 insertions, 0 deletions

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..109bafe
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,39 @@
+-*- mode: org; coding: utf-8; -*-
+
+#+TITLE: Hacking drmaa
+
+* Contributing
+
+By far the easiest way to hack on Guile DRMAA is to develop using Guix:
+
+#+BEGIN_SRC bash
+# Obtain the source code
+cd /path/to/source-code
+guix environment -l guix.scm
+# In the new shell, run:
+autoreconf -vif && ./configure && make check
+#+END_SRC
+
+You can now hack this project's files to your heart's content, whilst
+testing them from your =guix environment= shell.
+
+To try out any scripts in the project you can now use
+
+#+BEGIN_SRC bash
+./pre-inst-env scripts/${script-name}
+#+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
+
+Once those dependencies are installed you can run:
+
+#+BEGIN_SRC bash
+autoreconf -vif && ./configure && make check
+#+END_SRC