Commit 8abd6081 authored by Alex Sassmannshausen's avatar Alex Sassmannshausen

Initial commit.

parents
This project's license is GPL 3+.
You can read the full license at https://www.gnu.org/licenses/gpl.html.
-*- mode: org; coding: utf-8; -*-
#+TITLE: Hacking lens
* Contributing
By far the easiest way to hack on lens 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
-*- mode: org; coding: utf-8; -*-
#+TITLE: README for Guile Lens
\input texinfo
@c -*-texinfo-*-
@c %**start of header
@setfilename guile-lens.info
@documentencoding UTF-8
@settitle Guile Lens Reference Manual
@c %**end of header
@include version.texi
@copying
Copyright @copyright{} 2018 Alex Sassmannshausen
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled ``GNU Free
Documentation License''.
@end copying
@dircategory The Algorithmic Language Scheme
@direntry
* Guile Lens: (guile-lens)
@end direntry
@titlepage
@title The Guile Lens Manual
@author Alex Sassmannshausen
@page
@vskip 0pt plus 1filll
Edition @value{EDITION} @*
@value{UPDATED} @*
@insertcopying
@end titlepage
@contents
@c *********************************************************************
@node Top
@top Guile Lens
This document describes Guile Lens version @value{VERSION}.
@menu
* Introduction:: Why Guile Lens?
@end menu
@c *********************************************************************
@node Introduction
@chapter Introduction
INTRODUCTION HERE
This documentation is a stub.
@bye
(use-modules
(guix packages)
(guix licenses)
(guix download)
(guix build-system gnu)
(gnu packages)
(gnu packages autotools)
(gnu packages guile)
(gnu packages pkg-config)
(gnu packages texinfo))
(package
(name "guile-lens")
(version "0.1")
(source "./guile-lens-0.1.tar.gz")
(build-system gnu-build-system)
(arguments `())
(native-inputs
`(("autoconf" ,autoconf)
("automake" ,automake)
("pkg-config" ,pkg-config)
("texinfo" ,texinfo)))
(inputs `(("guile" ,guile-2.2)))
(propagated-inputs `())
(synopsis "")
(description "")
(home-page
"https://gitlab.com/a-sassmannshausen/")
(license gpl3+))
(hall-description
(name "lens")
(prefix "guile")
(version "0.1")
(author "Alex Sassmannshausen")
(copyright (2018))
(synopsis "")
(description "")
(home-page
"https://gitlab.com/a-sassmannshausen/")
(license gpl3+)
(dependencies `())
(files (libraries
((scheme-file "lens") (directory "lens" ())))
(tests ((directory "tests" ())))
(programs ((directory "scripts" ())))
(documentation
((text-file "README")
(text-file "HACKING")
(text-file "COPYING")
(directory "doc" ((texi-file "lens")))))
(infrastructure
((scheme-file "guix") (scheme-file "hall")))))
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment