diff --git a/README.md b/README.md deleted file mode 100644 index c2e6930..0000000 --- a/README.md +++ /dev/null @@ -1,78 +0,0 @@ -# Py65 - -Py65 provides tools for simulating hardware based on 6502-like -microprocessors. It has the following goals: - - - Focus on ease of use and modularity rather than performance. Py65 is - written in the Python programming language for productivity, while - similar programs are written in C for performance. - - - Enable simulations to be created for systems where it might have - otherwise not been practical, such as homebuilt computers. - - - Rigorously unit test all of the components. While the tools provided - by Py65 may not always be perfect, their behavior is verified through - tests so unexpected results are minimized. - -## Installation - -Py65 packages are [available](http://pypi.python.org/pypi/py65) on the -Python Package Index (PyPI). You download them from there or you can -use `easy_install` to automatically install or upgrade Py65: - - $ easy_install -U py65 - -## Devices - -The following devices are simulated at this time: - - - `mpu6502` simulates the original NMOS 6502 microprocessor from MOS - Technology, later known as Commodore Semiconductor Group (CSG). At this - time, all of the documented opcodes are supported. Support for the - illegal opcodes is planned for the future. - - - `mpu65c02` simulates a generic CMOS 65C02 microprocessor. There were - several 65C02 versions from various manufacturers, some with more opcodes - than others. This simulation is based on the W65C02S from the Western - Design Center (WDC). - - - `mpu65org16` simulates the 65Org16, a 6502-like microprocessor with a 16-bit - data bus and 32-bit address bus. This microprocessor is a project of the - [6502.org community](http://forum.6502.org/viewtopic.php?t=1824) and a - [Verilog core](https://github.com/BigEd/verilog-6502/wiki) for it has been - implemented. - -## Monitor - -Py65 includes a console-based machine language monitor (sometimes also called -a debugger). This program, `py65mon`, allows you to interact with the -simulations that you build. Its features include: - - - Commands that are largely compatible with those used in the monitor of - the popular VICE emulator for Commodore computers. - - - Ability to load, dump, and fill memory. - - - Simple assemble and disassemble capability, including support for labels - and labels with offsets. - -## Documentation - -Py65 documentation is written using [Sphinx](http://sphinx.pocoo.org/) and is -published to [http://py65.readthedocs.org/](http://py65.readthedocs.org/) - -## Contributors - -These people are responsible for Py65: - - - [Mike Naberezny](https://github.com/mnaberez) is the original author of - Py65 and is the primary maintainer. - - - [Oscar Lindberg](https://github.com/offe) started the 65C02 simulation - module and contributed greatly to its implementation. - - - [Ed Spittles](https://github.com/biged) wrote the 65Org16 simulation module - and provided many useful issue reports and patches. - - - [David Beazley](https://github.com/dabeaz) did the initial port of Py65 to - Python 3. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..4ad2db8 --- /dev/null +++ b/README.rst @@ -0,0 +1,85 @@ +Py65 +==== + +Py65 provides tools for simulating hardware based on 6502-like +microprocessors. It has the following goals: + +- Focus on ease of use and modularity rather than performance. Py65 is + written in the Python programming language for productivity, while + similar programs are written in C for performance. + +- Enable simulations to be created for systems where it might have + otherwise not been practical, such as homebuilt computers. + +- Rigorously unit test all of the components. While the tools provided + by Py65 may not always be perfect, their behavior is verified through + tests so unexpected results are minimized. + +Installation +------------ + +Py65 packages are `available `_ on the +Python Package Index (PyPI). You download them from there or you can +use ``easy_install`` to automatically install or upgrade Py65:: + + $ easy_install install -U py65 + +Devices +------- + +The following devices are simulated at this time: + +- ``mpu6502`` simulates the original NMOS 6502 microprocessor from MOS + Technology, later known as Commodore Semiconductor Group (CSG). At this + time, all of the documented opcodes are supported. Support for the + illegal opcodes is planned for the future. + +- ``mpu65c02`` simulates a generic CMOS 65C02 microprocessor. There were + several 65C02 versions from various manufacturers, some with more + opcodes than others. This simulation is based on the W65C02S from the + Western Design Center (WDC). + +- ``mpu65org16`` simulates the 65Org16, a 6502-like microprocessor with a + 16-bit data bus and 32-bit address bus. This microprocessor is a project + of the `6502.org community `_ + and a `Verilog core `_ for it + has been implemented. + +Monitor +------- + +Py65 includes a console-based machine language monitor (sometimes also called +a debugger). This program, ``py65mon``, allows you to interact with the +simulations that you build. Its features include: + +- Commands that are largely compatible with those used in the monitor of + the popular VICE emulator for Commodore computers. + +- Ability to load, dump, and fill memory. + +- Simple assemble and disassemble capability, including support for labels + and labels with offsets. + +Documentation +------------- + +Py65 documentation is written using `Sphinx `_ and +is published to `http://py65.readthedocs.org/ +`_. + +Contributors +------------ + +These people are responsible for Py65: + +- `Mike Naberezny `_ is the original author of + Py65 and is the primary maintainer. + +- `Oscar Lindberg `_ started the 65C02 simulation + module and contributed greatly to its implementation. + +- `Ed Spittles `_ wrote the 65Org16 simulation + module and provided many useful issue reports and patches. + +- `David Beazley `_ did the initial port of Py65 + to Python 3.