diff --git a/MANIFEST.in b/MANIFEST.in index b18346a9..6d38af9f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,10 +2,5 @@ include MANIFEST.in include README.md include CHANGELOG.md include Makefile -include machine/musashi/softfloat/softfloat-macros -include machine/musashi/softfloat/softfloat-specialize -include machine/musashi/*.txt recursive-include amitools/data * recursive-include amitools/fs/block/bootcode * -recursive-include machine *.pyx *.c *.h -recursive-include gen *.c *.h diff --git a/Makefile b/Makefile index 7a24acf7..9b76337a 100644 --- a/Makefile +++ b/Makefile @@ -75,7 +75,6 @@ clean_py: clean_ext: $(PYTHON) setup.py clean - rm -f machine/*.so machine/emu.c # install, distrib install: diff --git a/README.md b/README.md index f30a498e..09edd298 100644 --- a/README.md +++ b/README.md @@ -25,33 +25,42 @@ will be very helpful. ### Optional Packages - [lhafile - FS Edition][2]: required to use ```.lha``` file scanner -- [cython][3]: (version >= **3.0.0**) required to rebuild the native module +- [machine68k][3]: required to run `vamos` [1]: https://pip.pypa.io/en/stable/installation/ [2]: https://github.com/FrodeSolheim/python-lhafile -[3]: https://cython.org +[3]: https://github.com/cnvogelg/machine68k/ ## Installation ### Stable/Release Version +If you only need the tools without `vamos` then you can install the pure +Python version: + ```bash pip3 install amitools ``` +If you want to run `vamos` then you need the CPU emulator from the `machine68k` +package and you can install this dependency with: + +```bash +pip3 install 'amitools[vamos]' +``` + Note: - on Linux/macOS may use ``sudo`` to install for all users -- requires a host C compiler to compile the extension. - the version may be a bit outdated. If you need recent changes use the current version. ### Current Version from GitHub -Ensure you have Cython installed: +If you wan to run `vamos` then first install the CPU emulator `machine68k`: ```bash -pip3 install cython +pip3 install -U git+https://github.com/cnvogelg/machine68k.git ``` Then install `amitools` directly from the git repository: @@ -70,10 +79,10 @@ Note: - Follow this route if you want to hack around with the amitools codebase - Clone the Git repo: [amitools@git](https://github.com/cnvogelg/amitools) -- Ensure you have Cython installed: +- Ensure you have Cython and `machine68k` installed: ```bash -pip3 install cython +pip3 install cython machine68k ``` - Enter the directory of the cloned repo and install via pip: @@ -99,6 +108,8 @@ The new Documentation of `amitools` is hosted on [readthedocs][4] and dos calls with its own implementation and maps all file access to your local file system. + Note: `vamos` requires the package `machine68k` installed first! + - [xdftool][5] Create and modify ADF or HDF disk image files. diff --git a/requirements-dev.txt b/requirements-dev.txt index 6496e3c1..ef475b77 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -4,3 +4,4 @@ twine tox black build +machine68k diff --git a/requirements-test.txt b/requirements-test.txt index 1fa6dff5..f3499cf8 100644 --- a/requirements-test.txt +++ b/requirements-test.txt @@ -1,2 +1,3 @@ pytest pytest-benchmark +machine68k