~brenns10/funlisp

4359289ca21eb8f8352b85c073b2760f6cfbdc7a — Stephen Brennan 2 years ago 4ed4895
more doc update
1 files changed, 8 insertions(+), 3 deletions(-)

M doc/index.rst
M doc/index.rst => doc/index.rst +8 -3
@@ 7,17 7,22 @@ documentation contains information for those looking to learn the language, as
well as those looking to embed and extend it.

You can get started by cloning the repository from GitHub, and then compiling
the REPL:
the main program:

.. code::

    $ git clone https://github.com/brenns10/funlisp
    $ make bin/repl
    $ make bin/funlisp
    $ bin/funlisp
    > (define hello (lambda () (print "hello world")))
    <lambda function>
    <lambda hello>
    > (hello)
    hello world

If you do not have the a POSIX.2 system, or if you cannot install the Readline
library (on which the main program depends), you can use the simpler (but less
feature-rich) programs ``bin/repl`` and ``bin/runfile``.

From there, you can evaluate some arithmetic and write some lambdas! See the
table of contents below for guidance on the language, and how to embed the
interpreter in your program. There is also some (limited) documentation on the