.. PythonOberon documentation master file, created by
sphinx-quickstart on Sun May 12 15:49:46 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Python Oberon v0.1.0
========================================
An emulator written in Python for the Project Oberon RISC processor. If
`PyGame `_ is available it will open a screen of the standard dimensions of
1024 x 768 pixels. There's also a very crude "assembler".
* `Documentation `_
* `Source code `_ (`mirror `_)
* `Bugs & issues `_
* `On PyPI `_
Installing
----------------------------------
The usual way from PyPI::
pip install PythonOberon
Starting the Emulator
----------------------------------
Once you have downloaded the code you can start the emulator from the
base directory with::
python -i -m oberon
It will use the ``disk.img`` file and run for eight million cycles by
default. At around 3400000 cycles the screen background begins to fill
in, and at around 6500000 cycles the window content begins to be drawn.
(The ``-i`` option tells the Python interpreter to drop into the
interactive REPL after cycling the emulator. Without it the script will
just exit and the screen will disappear.)
If you want to see something right away there's a tiny binary that can
be loaded by the bootloader from a (virtual) serial port. It fills the
screen with a simple pattern of vertical bars::
python -m oberon --serial-in fillscreen.bin
Screenshot
----------------------------------
After eight million cycles:
.. image:: _static/Screenshot.png
Module Documentation
----------------------------------
.. toctree::
:maxdepth: 2
assembler
bootloader
demo
display
risc
util
IDE
Information on Oberon
----------------------------------
* `Oberon 2013 `_
* `projectoberon.com `_
* `Project Oberon emulator in C `_
* `Project Oberon emulators in JavaScript and Java `_
* `A resource page for Oberon-07 `_
Indices and tables
----------------------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`