Metadata-Version: 2.1
Name: gumnut-simulator
Version: 1.0.0
Summary: Gumnut Simulator written in Python
Home-page: https://github.com/bwiessneth/gumnut-simulator
Author: Benjamin Wiessneth
Author-email: b.wiessneth@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: gumnut-assembler
Provides-Extra: dev
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: setuptools ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'

Gumnut Simulator
################

This projects contains several components which all revolve around Peter Ashenden's 8-bit soft-core
called *Gumnut*. For more information refer to *The Designers Guide to VHDL*
https://www.sciencedirect.com/book/9780120887859/the-designers-guide-to-vhdl

This repository was forked from my very first implementation created at the laboratory for digital
engineering at the University of Applied Sciences Augsburg back in 2015.



Documentation
*************

Please refer to https://gumnut-simulator.readthedocs.org



Changelog
*********


1.0.0
=====

Changed
-------

-  Enforced proper module names and naming convention



0.0.1
=====

Added
-----

-  Documentation (still in progress, though)
-  Introduced ``tox`` for handling testing, build, and publishing tasks
-  Introduced Github Actions for automated testing

Changed
-------

-  Replaced ``nosetest`` with ``pytest`` as the choice for unit and
   integration testing
-  Updated the existing tests for ``pytest``

Fixed
-----

-  Module imports were fixed
-  Enforced flake8 and (to some extend) pylint linting


