Rabbit-vm Files

Rabbit-vm   an approach to the Joy programming language 
-------------------------------------------------------

This is work under construction and 

is not going to compile or run without modifications.


The code is up here for discussion.


For feedback of any sort please mail to sts-q at sourgeforde.



rabbit-vm.tar.gz contains the following files
---------------------------------------------

README

rabbit-run
        bash script
        Called with no parameters it prints out a short help message.
        With parameters it calls a precompiled binary of rabbit-vm 
        or compiles a new one.

rabbit-vm-c-linux-64
        precompiled to byte code

rabbit-vm-opt-linux-64
        precompiled to native code

./doc
        Documentation of the code of rabbit-vm as generated by ocamldoc.

./ocaml
        source code of rabbit-vm

./rabbit
        source code running on rabbit-vm

./temp
        initialy empty
        For files created by ocaml when compiling.

LICENSE



dependencies
------------

rlwrap
        Working in a REPL without a line editor is no fun.
        Rabbit-vm goes well with rlwrap. Any other should do, too.

        http://utopia.knoware.nl/~hlub/uck/rlwrap/

OCaml
        Rabbit-vm is written in the OCaml programming language.

        The tarball includes precompiled binarys for bytecode and native code (opt).

        If you would like to compile your own, you need OCaml.
        Release 4.00 should do.

        homepage: http:/ocaml.org

Linux
        This is compiled on Linux.

Both, rlwrap and OCaml, are likely to be in your Linux distro.



Does it work?
-------------

Move to the directory where you unpacked the tarball.
Type 

    ./rabbit-run

You should see a short help message.


In order to start rabbit-vm type

    ./rabbit-run downloaded c

You should see a promt like

       Stk>

    rabbit> _


Type at this prompt:
         2 3 * <enter>

The answer should be:

       Stk> 6

    rabbit> _


To exit REPL type just <enter> on an empty line.



Start to play
-------------

'./rabbit/first.rabbit' is the first file rabbit-vm reads.
Edit and save this file, (without changing it's name) 
and restart.



Best Regards
Heiko




---
    Rabbit-vm   an approach to the Joy programming language 
    Copyright (C) 2014  Heiko Kuhrt

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
---