What's legOS?
-------------

legOS is a small embedded OS for the LEGO Mindstorms RCX. legOS applications
can be written in C and assembler, C++ is currently being tested.


Give me details
---------------

* See LICENSE for licensing terms. legOS is under Mozilla Public License
  now because I incorporated most of Kekoa's math routines.

* See CONTRIBUTORS to see who's working on the project.


Getting started
---------------

1) To compile legOS and legOS applications, you'll need a Hitachi H8 tool
   suite. Check the legOS web page http://www.multimania.com/legOS/ for
   details.

2) Edit Makefile.common, setting up your tool prefix and the path to your
   legOS directory. 
 
3) Type make. You should end up with an executable, demo/*.srec.

4) Use util/firmdl or your favourite firmware downloader to try out the
   demo on your RCX.

   
Documentation
-------------

All the documentation there is can be found in doc/.

Depending on your distribution, you may or may not have HTML pages with API
documentation in doc/html. It can be generated from the sources with a
tool called doxygen, see http://www.stack.nl/~dimitri/doxygen/. Just type
"make html" to generate them yourself if you have the tool.


Enjoy yourselves,

Markus L. Noga <noga@inrialpes.fr>
