view readme.rst @ 376:1e951e71d3f1

Change to readme
author Windel Bouwman
date Tue, 25 Mar 2014 19:36:51 +0100
parents 899ae3aea803
children 9667d78ba79e
line wrap: on
line source


About
=====

Project goals
-------------

* To write a microkernel based OS
* Write the kernel in the c3 language
* Create a c3 compiler in python

Directory structure
-------------------

'kernel' contains the microkernel.
'python' contains the python utilities.


How to run this?
----------------

Install required software:

* python3.3
* pyyaml for yaml module
* (optional) pyqt5, pyqt4 or pyside

Checkout the code:

.. code:: bash

    hg clone https://bitbucket.org/windel/lcfos
    cd lcfos

Run some unit tests:

.. code:: bash

    cd test
    python3 run_tests.py


Weblinks
--------

Docs are located here:
http://lcfos.readthedocs.org/en/latest/

Sources are located here:
https://bitbucket.org/windel/lcfos

here:
http://hg.assembla.com/lcfOS/

and here:
https://pikacode.com/windel/lcfos/


The project is contains tests which are run continuously at drone.io.

.. image:: https://drone.io/bitbucket.org/windel/lcfos/status.png

https://drone.io/bitbucket.org/windel/lcfos

Repository metrics:

.. image:: https://www.ohloh.net/p/lcfos/widgets/project_thin_badge.gif

http://www.ohloh.net/p/lcfos