From d6851d10087a1b9756fca51e6996b4974d4ee783 Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Fri, 9 Jun 2023 08:38:39 -0500 Subject: Update README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) 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. ## Usage +### Library: `chicken-scratch` + `expand-string` is the main entry point to this module. It takes a string and returns a string with all `#( ... )` forms expanded according to the CHICKEN rules. `expand-port` is a port version of `expand-string`. @@ -31,5 +33,10 @@ in the expanded string. Finally, to enable CHICKEN-SCRATCH to be used in a shebang, if the first line of the input string begins with `#!`, it's deleted from the input. +### Executable: `chicken-scratch` + +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. + ## Installation +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. -- cgit 1.4.1-21-gabe81