aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWojtek Kosior <koszko@koszko.org>2023-12-09 10:45:35 +0100
committerWojtek Kosior <koszko@koszko.org>2023-12-12 19:28:20 +0100
commitd2048b6c0c81b9b944354f6f66c353d65ee469a8 (patch)
treeb0409e35b984493b152abf9ac796e2e0efa45d98
downloadlawrence-boilerplate-d2048b6c0c81b9b944354f6f66c353d65ee469a8.tar.gz
lawrence-boilerplate-d2048b6c0c81b9b944354f6f66c353d65ee469a8.zip
Initial commit.
-rw-r--r--.gitignore15
-rw-r--r--.reuse/dep54
-rw-r--r--LICENSES/CC0-1.0.txt121
-rw-r--r--Makefile.am13
-rw-r--r--README.md49
-rw-r--r--README.md.license3
-rw-r--r--ax_add_guile_pre_inst_env.m441
-rwxr-xr-xbootstrap8
-rw-r--r--configure.ac13
9 files changed, 267 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..de43d0f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,15 @@
+# SPDX-License-Identifier: CC0-1.0
+#
+# Copyright (C) 2023 Wojtek Kosior <koszko@koszko.org>
+
+Makefile
+Makefile.in
+aclocal.m4
+autom4te.cache
+config.log
+config.status
+configure
+configure~
+install-sh
+missing
+lawrence-boilerplate-*.tar.gz
diff --git a/.reuse/dep5 b/.reuse/dep5
new file mode 100644
index 0000000..bd41f4a
--- /dev/null
+++ b/.reuse/dep5
@@ -0,0 +1,4 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: Lawrence boilerplate
+Upstream-Contact: Wojtek Kosior <koszko@koszko.org>
+Source: https://git.koszko.org/lawrence-boilerplate/about
diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt
new file mode 100644
index 0000000..0e259d4
--- /dev/null
+++ b/LICENSES/CC0-1.0.txt
@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+ CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+ LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+ ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+ INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+ REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+ PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+ THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+ HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+ i. the right to reproduce, adapt, distribute, perform, display,
+ communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+ likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+ subject to the limitations in paragraph 4(a), below;
+ v. rights protecting the extraction, dissemination, use and reuse of data
+ in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+ European Parliament and of the Council of 11 March 1996 on the legal
+ protection of databases, and under any national implementation
+ thereof, including any amended or successor version of such
+ directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+ world based on applicable law or treaty, and any national
+ implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+ surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+ warranties of any kind concerning the Work, express, implied,
+ statutory or otherwise, including without limitation warranties of
+ title, merchantability, fitness for a particular purpose, non
+ infringement, or the absence of latent or other defects, accuracy, or
+ the present or absence of errors, whether or not discoverable, all to
+ the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+ that may apply to the Work or any use thereof, including without
+ limitation any person's Copyright and Related Rights in the Work.
+ Further, Affirmer disclaims responsibility for obtaining any necessary
+ consents, permissions or other rights required for any use of the
+ Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+ party to this document and has no duty or obligation with respect to
+ this CC0 or use of the Work.
diff --git a/Makefile.am b/Makefile.am
new file mode 100644
index 0000000..4d7464c
--- /dev/null
+++ b/Makefile.am
@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: CC0-1.0
+#
+# Copyright (C) 2023 Wojtek Kosior <koszko@koszko.org>
+
+aclocaldir = $(datarootdir)/aclocal
+dist_aclocal_DATA = ax_add_guile_pre_inst_env.m4
+
+EXTRA_DIST = \
+ LICENSES/CC0-1.0.txt \
+ .reuse/dep5 \
+ bootstrap \
+ .gitignore \
+ README.md.license
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.
diff --git a/README.md.license b/README.md.license
new file mode 100644
index 0000000..e54bf4d
--- /dev/null
+++ b/README.md.license
@@ -0,0 +1,3 @@
+SPDX-License-Identifier: CC0-1.0
+
+Copyright (C) 2023 Wojtek Kosior <koszko@koszko.org>
diff --git a/ax_add_guile_pre_inst_env.m4 b/ax_add_guile_pre_inst_env.m4
new file mode 100644
index 0000000..e5612d6
--- /dev/null
+++ b/ax_add_guile_pre_inst_env.m4
@@ -0,0 +1,41 @@
+dnl SPDX-License-Identifier: CC0-1.0
+dnl
+dnl Copyright (C) 2023 Wojtek Kosior <koszko@koszko.org>
+dnl
+dnl This file proviced an autoconf macro that generates a pre-inst-env script
+dnl suitable for use in Guile projects.
+dnl
+# AX_ADD_GUILE_PRE_INST_ENV([FILENAME = pre-inst-env],
+# [SCM_ROOT_PATH = src/guile],
+# [GO_ROOT_PATH = src/guile]
+# [SCRIPTS_PATH = scripts])
+# ------------------------------------------------------------------------------
+AC_DEFUN([AX_ADD_GUILE_PRE_INST_ENV], [
+printf '%s' '
+set -eu
+
+SOURCE_DIR='"$(cd "$srcdir" && pwd -P)"'
+BUILD_DIR="$(cd "$(dirname "[$]0")" && pwd -P)"
+
+export G''UILE_LOAD_PATH="$SOURCE_DIR/m4_default([$2], [src/guile])[]dnl
+${G''UILE_LOAD_PATH:+:}${G''UILE_LOAD_PATH:-}"
+
+export G''UILE_LOAD_COMPILED_PATH="$BUILD_DIR/m4_default([$3], [src/guile])[]dnl
+${G''UILE_LOAD_COMPILED_PATH:+:}${G''UILE_LOAD_COMPILED_PATH:-}"
+
+export G''UILE_AUTO_COMPILE=0
+
+export PATH="$SOURCE_DIR/m4_default([$3], [scripts])${PATH:+:}${PATH:-}"
+
+if test 0 = "[$]#"
+then :
+ "${SHELL:-/bin/sh}"
+else :
+ PROGRAM="[$]1"
+ shift
+ "$PROGRAM" "[$]@"
+fi
+' > m4_default([$1], [pre-inst-env])
+
+chmod 755 pre-inst-env
+])dnl AX_ADD_GUILE_PRE_INST_ENV
diff --git a/bootstrap b/bootstrap
new file mode 100755
index 0000000..0040cd3
--- /dev/null
+++ b/bootstrap
@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# SPDX-License-Identifier: CC0-1.0
+#
+# Copyright (C) 2023 Wojtek Kosior <koszko@koszko.org>
+
+cd "$(dirname "$0")"
+autoreconf --install
diff --git a/configure.ac b/configure.ac
new file mode 100644
index 0000000..59ac3cf
--- /dev/null
+++ b/configure.ac
@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: CC0-1.0
+#
+# Copyright (C) 2023 Wojtek Kosior <koszko@koszko.org>
+
+AC_INIT([lawrence-bolierplate], [0.1], [koszko@koszko.org])
+
+AC_CONFIG_SRCDIR([ax_add_guile_pre_inst_env.m4])
+
+AM_INIT_AUTOMAKE([-Wall -Werror foreign])
+
+AC_CONFIG_FILES([Makefile])
+
+AC_OUTPUT