diff options
Diffstat (limited to 'README')
-rw-r--r-- | README | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README b/README new file mode 100644 index 0000000..aa4af14 --- /dev/null +++ b/README | |||
@@ -0,0 +1,31 @@ | |||
1 | SCRAMBLE : turn an egg into a Makefile | ||
2 | (look the name's not clever. so it goes) | ||
3 | |||
4 | Scramble turns a CHICKEN egg into a Makefile. | ||
5 | It's pretty similar in function to `chicken-install`, | ||
6 | except that it puts all the build artifacts in `build/`. | ||
7 | |||
8 | Run it like this: | ||
9 | |||
10 | scramble [egg-directory-or-name] | ||
11 | |||
12 | where EGG-DIRECTORY-OR-NAME is the directory in which the .egg resides, | ||
13 | or the name of the .egg itself. It defaults to the current directory. | ||
14 | |||
15 | Scramble will output the Makefile to standard out. | ||
16 | Redirect it to a file to save it. | ||
17 | |||
18 | To install scramble, run | ||
19 | |||
20 | make install | ||
21 | |||
22 | on this repo, or run | ||
23 | |||
24 | chicken-install -s | ||
25 | |||
26 | either will work :) | ||
27 | |||
28 | The Makefile in this repo is generated with scramble. | ||
29 | |||
30 | Scramble is licensed under the BSD 3-clause license. | ||
31 | Details in COPYING. \ No newline at end of file | ||