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

---
 README | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README

(limited to 'README')

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
-- 
cgit 1.4.1-21-gabe81