Metadata-Version: 2.0
Name: PyCpuSimulator
Version: 0.2.1
Summary: PyCpuSimulator is a CPU simulator
Home-page: https://github.com/FabriceSalvaire/PyCpuSimulator
Author: Fabrice Salvaire
Author-email: fabrice.salvaire@orange.fr
License: GPLv3
Description-Content-Type: UNKNOWN
Keywords: cpu core avr simulator micro-code
Platform: any
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Education
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: PyYAML
Requires-Dist: numpy
Requires-Dist: ansicolor
Requires-Dist: ply

.. -*- Mode: rst -*-

.. -*- Mode: rst -*-

..
   |PyCpuSimulatorUrl|
   |PyCpuSimulatorHomePage|_
   |PyCpuSimulatorDoc|_
   |PyCpuSimulator@github|_
   |PyCpuSimulator@readthedocs|_
   |PyCpuSimulator@readthedocs-badge|
   |PyCpuSimulator@pypi|_

.. |ohloh| image:: https://www.openhub.net/accounts/230426/widgets/account_tiny.gif
   :target: https://www.openhub.net/accounts/fabricesalvaire
   :alt: Fabrice Salvaire's Ohloh profile
   :height: 15px
   :width:  80px

.. |PyCpuSimulatorUrl| replace:: http://fabricesalvaire.github.io/PyCpuSimulator

.. |PyCpuSimulatorHomePage| replace:: PyCpuSimulator Home Page
.. _PyCpuSimulatorHomePage: http://fabricesalvaire.github.io/PyCpuSimulator

.. |PyCpuSimulatorDoc| replace:: PyCpuSimulator Documentation
.. _PyCpuSimulatorDoc: http://pyspice.readthedocs.org/en/latest

.. |PyCpuSimulator@readthedocs-badge| image:: https://readthedocs.org/projects/pyspice/badge/?version=latest
   :target: http://pyspice.readthedocs.org/en/latest

.. |PyCpuSimulator@github| replace:: https://github.com/FabriceSalvaire/PyCpuSimulator
.. .. _PyCpuSimulator@github: https://github.com/FabriceSalvaire/PyCpuSimulator

.. |PyCpuSimulator@readthedocs| replace:: http://pyspice.readthedocs.org
.. .. _PyCpuSimulator@readthedocs: http://pyspice.readthedocs.org

.. |PyCpuSimulator@pypi| replace:: https://pypi.python.org/pypi/PyCpuSimulator
.. .. _PyCpuSimulator@pypi: https://pypi.python.org/pypi/PyCpuSimulator

.. |Build Status| image:: https://travis-ci.org/FabriceSalvaire/PyCpuSimulator.svg?branch=master
   :target: https://travis-ci.org/FabriceSalvaire/PyCpuSimulator
   :alt: PyCpuSimulator build status @travis-ci.org

.. |Pypi Download| image:: https://img.shields.io/pypi/dm/PyCpuSimulator.svg
   :target: https://pypi.python.org/pypi/PyCpuSimulator
   :alt: PyCpuSimulator Download per month

.. |Pypi Version| image:: https://img.shields.io/pypi/v/PyCpuSimulator.svg
   :target: https://pypi.python.org/pypi/PyCpuSimulator
   :alt: PyCpuSimulator last version

.. |Pypi License| image:: https://img.shields.io/pypi/l/PyCpuSimulator.svg
   :target: https://pypi.python.org/pypi/PyCpuSimulator
   :alt: PyCpuSimulator license

.. |Pypi Format| image:: https://img.shields.io/pypi/format/PyCpuSimulator.svg
   :target: https://pypi.python.org/pypi/PyCpuSimulator
   :alt: PyCpuSimulator format

.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/PyCpuSimulator.svg
   :target: https://pypi.python.org/pypi/PyCpuSimulator
   :alt: PyCpuSimulator python version

..  coverage test
..  https://img.shields.io/pypi/status/Django.svg
..  https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star

.. End
.. -*- Mode: rst -*-

.. |Python| replace:: Python
.. _Python: http://python.org

.. |PyPI| replace:: PyPI
.. _PyPI: https://pypi.python.org/pypi

.. |Numpy| replace:: Numpy
.. _Numpy: http://www.numpy.org

.. |Sphinx| replace:: Sphinx
.. _Sphinx: http://sphinx-doc.org

.. |pypy| replace:: pypy
.. _pypy: http://pypy.org

================
 PyCpuSimulator
================

|Pypi License|
|Pypi Python Version|

|Pypi Version|

.. * Quick Link to `Production Branch <https://github.com/FabriceSalvaire/PyCpuSimulator/tree/master>`_
.. * Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/PyCpuSimulator/tree/devel>`_

Overview
========

What is PyCpuSimulator ?
------------------------

PyCpuSimulator is a CPU simulator implemented in Python which use micro-codes to implement CPU core.

Where is the Documentation ?
----------------------------

The documentation is available on the |PyCpuSimulatorHomePage|_.

What are the main features ?
----------------------------

* Micro-Code Language to describe instruction
* Opcode Decoder using Decision Tree
* Read HEX firmware format
* AVR Core CPU simulation is ongoing

How to install it ?
-------------------

Look at the `installation <@project_url@/installation.html>`_ section in the documentation.

Credits
=======

Authors: `Fabrice Salvaire <http://fabrice-salvaire.fr>`_


