Skip to content

Personal GNU Guile Library

License

AGPL-3.0, Unknown licenses found

Licenses found

AGPL-3.0
LICENSE
Unknown
COPYING
Notifications You must be signed in to change notification settings

yewscion/guile-cdr255

Repository files navigation

The guile-cdr255 README

Yewscion's Guile Library.

Last Updated: 2022-11-03 (W44) 00:22:17 GMT

This is a user library for GNU Guile. I'm building it up as I find I need to reuse code, rather than having various procedures reimplemented across various projects for no reason.

Installation

GNU Guix

If You use GNU Guix, this package is on my channel.

Once You have it set up, You can just run:

guix pull
guix install guile-cdr255

If You just want to try it out, You can use Guix Shell instead:

guix shell guile-cdr255 bash --pure

And if You'd rather just try it out without my channel, You can clone this repo and then do:

cd guile-cdr255
guix shell -f guix.scm bash --pure

This'll create a profile with just this project in it, to mess around with.

Source

If You don't want to use GNU Guix, You can clone this repo and install it in the normal way:

git clone https://git.sr.ht/~yewscion/guile-cdr255
cd guile-cdr255
./configure
make
make check
make install

If You don't want to use git, or would rather stick with an actual release, then see the tagged releases for some tarballs of the source.

The needed dependencies are tracked in the DEPENDENCIES.txt file to support this use case.

Usage

Full usage is documented in the doc/guile-cdr255.info file. Here are only generic instructions.

Once guile-cdr255 in installed, You should be able to access all of its exported functions in guile by using its modules:

(use-modules (cdr255 main))

Any binaries or scripts will be available in Your $PATH. A list of these is maintained in the info file. They all also have the --help= flag, so if You prefer learning that way, that is also available.

Contributing

Pull Requests are welcome, as are bugfixes and extensions. Please open issues as needed. If You contribute a feature, needs to be tests and documentation.

Development is expected to be done using GNU Guix. If You have guix set up, You should be able to enter a development environment with the following:

cd guile-cdr255
guix shell -D -f guix.scm bash --pure

If You've made changes without the above precautions, those changes will need to be confirmed to work in the above environment before merge.

License

The guile-cdr255 project and all associated files are ©2022 Christopher Rodriguez, but licensed to the public at large under the terms of the:

GNU AGPL3.0+ license.

Please see the LICENSE file and the above link for more information.

About

Personal GNU Guile Library

Resources

License

AGPL-3.0, Unknown licenses found

Licenses found

AGPL-3.0
LICENSE
Unknown
COPYING

Stars

Watchers

Forks

Packages

No packages published