HACKING

   1 -*- mode: org; coding: utf-8; -*-
   2
   3 #+TITLE: Hacking irrlicht
   4
   5 * Contributing
   6
   7 By far the easiest way to hack on irrlicht is to develop using Guix:
   8
   9 #+BEGIN_SRC bash
  10   # Obtain the source code
  11   cd /path/to/source-code
  12   guix environment -l guix.scm
  13   # In the new shell, run:
  14   hall dist --execute && autoreconf -vif && ./configure && make check
  15 #+END_SRC
  16
  17 You can now hack this project's files to your heart's content, whilst
  18 testing them from your `guix environment' shell.
  19
  20 To try out any scripts in the project you can now use
  21
  22 #+BEGIN_SRC bash
  23   ./pre-inst-env scripts/${script-name}
  24 #+END_SRC
  25
  26 If you'd like to tidy the project again, but retain the ability to test the
  27 project from the commandline, simply run:
  28
  29 #+BEGIN_SRC bash
  30   ./hall clean --skip "scripts/${script-name},pre-inst-env" --execute
  31 #+END_SRC
  32
  33 ** Manual Installation
  34
  35 If you do not yet use  Guix, you will have to install this project's
  36 dependencies manually:
  37   - autoconf
  38   - automake
  39   - pkg-config
  40   - texinfo
  41   - guile-hall
  42
  43 Once those dependencies are installed you can run:
  44
  45 #+BEGIN_SRC bash
  46   hall dist -x && autoreconf -vif && ./configure && make check
  47 #+END_SRC