diff options
| -rw-r--r-- | README.md | 7 |
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 |
| 23 | returns a string with all `#( ... )` forms expanded according to the CHICKEN | 25 | returns a string with all `#( ... )` forms expanded according to the CHICKEN |
| 24 | rules. `expand-port` is a port version of `expand-string`. | 26 | rules. `expand-port` is a port version of `expand-string`. |
| @@ -31,5 +33,10 @@ in the expanded string. | |||
| 31 | Finally, to enable CHICKEN-SCRATCH to be used in a shebang, if the first line | 33 | Finally, to enable CHICKEN-SCRATCH to be used in a shebang, if the first line |
| 32 | of the input string begins with `#!`, it's deleted from the input. | 34 | of the input string begins with `#!`, it's deleted from the input. |
| 33 | 35 | ||
| 36 | ### Executable: `chicken-scratch` | ||
| 37 | |||
| 38 | Run `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 | ||
| 42 | Running `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. | ||