From 16139a033dfb80b4ea4305a873d28c4920a81bf8 Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Tue, 28 May 2024 22:51:06 -0500 Subject: Add README, LICENSE --- COPYING | 26 ++++++++++++++++++++++++++ README | 31 +++++++++++++++++++++++++++++++ scramble.egg | 1 + 3 files changed, 58 insertions(+) create mode 100644 COPYING create mode 100644 README diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..7e3eab2 --- /dev/null +++ b/COPYING @@ -0,0 +1,26 @@ +Copyright 2024 Case Duckworth + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors + may be used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README b/README new file mode 100644 index 0000000..aa4af14 --- /dev/null +++ b/README @@ -0,0 +1,31 @@ +SCRAMBLE : turn an egg into a Makefile +(look the name's not clever. so it goes) + +Scramble turns a CHICKEN egg into a Makefile. +It's pretty similar in function to `chicken-install`, +except that it puts all the build artifacts in `build/`. + +Run it like this: + + scramble [egg-directory-or-name] + +where EGG-DIRECTORY-OR-NAME is the directory in which the .egg resides, +or the name of the .egg itself. It defaults to the current directory. + +Scramble will output the Makefile to standard out. +Redirect it to a file to save it. + +To install scramble, run + + make install + +on this repo, or run + + chicken-install -s + +either will work :) + +The Makefile in this repo is generated with scramble. + +Scramble is licensed under the BSD 3-clause license. +Details in COPYING. \ No newline at end of file diff --git a/scramble.egg b/scramble.egg index 28df21b..6a8eeac 100644 --- a/scramble.egg +++ b/scramble.egg @@ -1,5 +1,6 @@ ((author "Case Duckworth") (synopsis "Convert an egg to a Makefile") + (license "BSD-3") (dependencies (chicken "5.3.0") utf8 srfi-1) ;; (test-dependencies test) (component-options -- cgit 1.4.1-21-gabe81