The source files of Guile Aux are available in a git repository. You can get a copy like so:
$ git clone https://codeberg.org/luis-felipe/guile-aux.git
The source code is organized as follows:
guile-aux ├── aux ← The library. ├── doc ← Source files of the documentation you are reading. ├── requirements ← Lists of OS and Guile dependencies. ├── tests ← Test suite for aux library. ├── guile-aux.svg ← An identifying image for the project. └── README.org ← A summary of the project.
To work with the source files you first need to create an environment for the project and install the software this project depends upon.
The following instructions indicate how to create such an environment using GNU Guix.
Run the following commands to create an environment with all the software required to work on the project:
$ cd path/to/guile-aux $ guix shell -m requirements/guix.scm --pure
When you are done working, you can leave the environment by pressing Ctrl+D.
This project uses SRFI-64 and Guile Probá for its test suite. You can run the suite as follows:
$ cd path/to/guile-aux $ proba run tests
A summarized report is displayed on screen, and a complete log is saved to a location indicated in the same report.
The documentation in the doc directory is written in the GNU Texinfo format. An HTML version is built and published online when there are new updates.
To build the documentation locally, run the following commands:
$ cd path/to/guile-aux/doc/ $ ./build-manual.sh
After running this command, you can open the documentation in your Web browser using this address file:///tmp/guile-aux/index.html.