about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorCase Duckworth2023-06-09 08:38:39 -0500
committerCase Duckworth2023-06-09 08:38:39 -0500
commitd6851d10087a1b9756fca51e6996b4974d4ee783 (patch)
tree2f951890444eaeaef6971688797230d61e704a90
parentAdd egg and makefile and program (diff)
downloadchicken-scratch-d6851d10087a1b9756fca51e6996b4974d4ee783.tar.gz
chicken-scratch-d6851d10087a1b9756fca51e6996b4974d4ee783.zip
Update README
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md index 6aec41f..df53a19 100644 --- a/README.md +++ b/README.md
@@ -19,6 +19,8 @@ with scheme. Thus, CHICKEN-SCRATCH was born.
19 19
20## Usage 20## Usage
21 21
22### Library: `chicken-scratch`
23
22`expand-string` is the main entry point to this module. It takes a string and 24`expand-string` is the main entry point to this module. It takes a string and
23returns a string with all `#( ... )` forms expanded according to the CHICKEN 25returns a string with all `#( ... )` forms expanded according to the CHICKEN
24rules. `expand-port` is a port version of `expand-string`. 26rules. `expand-port` is a port version of `expand-string`.
@@ -31,5 +33,10 @@ in the expanded string.
31Finally, to enable CHICKEN-SCRATCH to be used in a shebang, if the first line 33Finally, to enable CHICKEN-SCRATCH to be used in a shebang, if the first line
32of the input string begins with `#!`, it's deleted from the input. 34of the input string begins with `#!`, it's deleted from the input.
33 35
36### Executable: `chicken-scratch`
37
38Run `chicken-scratch FILENAME ...` on the command line. In a future version I'll include a few compile flags and the ability to read from standard input.
39
34## Installation 40## Installation
35 41
42Running `make` in this directory will call `chicken-install -n`, leaving you with a `chicken-scratch` binary. Run `make install` to install the program to `$PREFIX`, or `make chicken-install` to run `chicken-install` without the `-n` flag. Or, you know, run those commands yourself.