~brenns10/funlisp

b97ea02f8f644fba2314dd0856740b01db41c2ea — Stephen Brennan 3 years ago e967c46
Readme update for new library target
1 files changed, 10 insertions(+), 5 deletions(-)

M README.md
M README.md => README.md +10 -5
@@ 2,13 2,18 @@ funlisp
=======

Another lisp implementation, this time aiming to be self-contained, portable,
well documented, and easy to embed and use.
well documented, and easy to embed and use.  This implementation is derived from
[libstephen lisp][], which is in turn built off the experience of an earlier
[attempt][lisp v1].

This implementation is derived from [libstephen lisp][], which is in turn built
off the experience of an earlier [attempt][lisp v1].
Public interface with some documentation is in [inc/funlisp.h](), and you can
build the library by simply running `make`. You'll find the result at
`bin/libfunlisp.a`.

To compile, a simple `make` should do. For debugging, you can use the
`make CFG=debug` configuration, which enables debugging symbols.
Sample applications embedding funlisp are located in [tools/](), currently only
a REPL. To build, e.g. `tools/repl.c`, you can do `make bin/repl`.

Sample scripts don't yet exist, but will soon.

[libstephen lisp]: https://github.com/brenns10/libstephen/tree/master/src/lisp
[lisp v1]: https://github.com/brenns10/lisp