8 bit Computer

This is a project to make a basic but fully functional 8 bit computer using 7400 series ICs.

The full docs can be found on the Read the Docs: https://eight-bit-computer.readthedocs.io/

Docs

To build the docs on mac run:

make clean
make html

in docs.

To build the docs in windows run:

sphinx-build.exe . _build

in docs. This also runs the apidoc command on build with a convenience function in conf.py.

Tests

To run the tests, run:

tox -e test

in the root directory.

Run:

tox -e test -- -m "not slow"

To avoid the slow checks.

To generate a coverage report run:

tox -e cov

in the root directory.

Release

python setup.py sdist bdist_wheel
python -m twine upload dist/*

License

The content of this project itself is licensed under the Attribution-ShareAlike 4.0 International license, and any source code used in conjunction with the project is licensed under the MIT license.