Easier68k is a python library that assembles and simulates the Motorola 68k CPU Architecture.
NOTE: Easier68k is currently under heavy production and is not stable.
Currently Easier68k is incomplete and is lacking in some ways that prevent it from being considered "fully featured".
Some goals for future development are:
Specific tasks for development are found on the Issues tab.
There are very few 68K simulators and assemblers and the ones that exist were all found to be lacking in some areas. We realized we could do better:
The cli is in the folder "easier68k-cli" which comes in this Github repository. Go to the easier68k-cli folder in the terminal/command prompt and install the dependencies with
python -m pip install -r requirements.txt
Then run the application with
python ./cli.py
You can now assemble and simulate a file
(easier68k) assemble ./file.x68, ./assembled.json
(easier68k) simulate ./assembled.json
(easier68k.simulate) run
(easier68k.simulate) exit
(easier68k) exit
See the readme in the easier68k-cli for complete documentation.
Easier68k currently targets only Python 3.5 and 3.6. Other versions may work, but are not actively supported.
See Easier68k-SampleProject as an example of incorporating this package into your code.
Add to your requirements.txt
and install:
# Add this repo to your project's requirements.txt (create one if it doesn't)
echo git+https://github.com/Chris-Johnston/Easier68k >> requirements.txt
# (re-)install your project requirements (you may want to include the --upgrade flag)
python -m pip install -r requirements.txt
Use the package in your code:
import easier68k
sim = easier68k.simulator.m68k.M68K()
# you can now use the package!
All of the tests can be run with the script ./.testingScript.sh
.
This will install the development version of the package locally and run all of the tests.
Doctests are implemented on most smaller methods and utility functions, and pytests are planned for the overall functionality.
A list of all modules to test is defined in tests/run_doctest.py
. Update this file when
new doctest-able modules are added to the CI.
This file can be run from the shell using python tests/run_doctest.py
.
Easier68k is under the MIT license.