You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47 lines
1.1 KiB
47 lines
1.1 KiB
# -*- mode: org; coding: utf-8; -*- |
|
|
|
#+TITLE: Hacking bible-tools |
|
|
|
* Contributing |
|
|
|
By far the easiest way to hack on bible-tools 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: |
|
hall dist --execute && 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 |
|
|
|
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 dist -x && autoreconf -vif && ./configure && make check |
|
#+END_SRC
|
|
|