diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ee16cb --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# de Paul records + +Software freedom empowers sharing. Let's dedicate our libre software projects +to saints known for fostering sharing! + +This Autoconf macro pakage is dedicated to St. Lawrence, a deacon martyred in +ancient Rome. Emperor Valerian — after having the pope executed — demanded that +Lawrence hands over all Church's treasures. Lawrence asked for 3 days to gather +all valueable items but instead used that time to give everything to the poor. +He's said to have told the emperor "These are the treasures of the Church." +while pointing at the poor roman folk. + +## What's here? + +Currently, there's just one macro, `AX_ADD_GUILE_PRE_INST_ENV()`. It causes a +`pre-inst-env` script to be written at user-chosen path (relative to build dir) +at `configure` time. The script helps amend the `GUILE_LOAD_PATH`, +`GUILE_LOAD_COMPILED_PATH` and `PATH` environment variables with useful paths — +by default `src/guile`, `src/guile` and `srcipts`, respectively, all relative to +build directory. + +The script can be invoked as + +```shell-script +./pre-inst-env <command> [arguments]... +``` + +to run the specified command with the desired environment or without arguments + +```shell-script +./pre-inst-env +``` + +to spawn a shell with these environment variables defined. + +Look at [de Paul records](https://git.koszko.org/de-paul-records/about) for an +example of how this can be integrated into a project. + +## Building & installation + +This software has a Guix package definition in Wojtek's [personal +channel](https://git.koszko.org/guix/about). That can serve you as a point of +reference. + +## Copying + +The source code of this package is available under CC0 v1.0. The repository is +kept compliant with the [REUSE](https://reuse.software/) specification, version +3.0. |