mirror of
https://github.com/robmcmullen/atrcopy.git
synced 2024-06-07 02:29:28 +00:00
Readme fixes
This commit is contained in:
parent
e9582cf95d
commit
47f9973d91
42
README.rst
42
README.rst
|
@ -1,21 +1,41 @@
|
||||||
atrcopy
|
atrcopy
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Command line utility to manage file systems on Atari 8-bit and Apple ][ disk
|
Python command line utility to manage file systems on Atari 8-bit and Apple ][
|
||||||
images.
|
disk images.
|
||||||
|
|
||||||
.. contents:: **Contents**
|
.. contents:: **Contents**
|
||||||
|
|
||||||
Prerequisites
|
Prerequisites
|
||||||
-------------
|
=============
|
||||||
|
|
||||||
``atrcopy`` 4.0 introduces a new command line argument structure based on
|
Python
|
||||||
subcommands, much like ``git`` uses ``git pull``, ``git clone``, ``git
|
------
|
||||||
branch``, etc. Upgrading to 4.0 will require modification of scripts that use
|
|
||||||
``atrcopy`` 3.x-style command line arguments.
|
Supported Python versions:
|
||||||
|
|
||||||
|
* Python 2.7
|
||||||
|
* Python 3.5
|
||||||
|
* Python 3.6
|
||||||
|
|
||||||
|
Python 3 compatibility was added in ``atrcopy`` 5.0, but support for Python 3.4
|
||||||
|
and older is not planned.
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
------------
|
||||||
|
|
||||||
Starting with ``atrcopy`` 2.0, `numpy <http://www.numpy.org/>`_ is required. It
|
Starting with ``atrcopy`` 2.0, `numpy <http://www.numpy.org/>`_ is required. It
|
||||||
will be automatically installed when installing ``atrcopy`` with::
|
will be automatically installed when installing ``atrcopy`` with ``pip`` as
|
||||||
|
described below.
|
||||||
|
|
||||||
|
It also uses the pure-Python ``future`` compatibility library to help support
|
||||||
|
both Python 2 and Python 3.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
``atrcopy`` is available in the `PyPI <https://pypi.python.org/pypi/atrcopy/>`_
|
||||||
|
and installable using ``pip``::
|
||||||
|
|
||||||
pip install atrcopy
|
pip install atrcopy
|
||||||
|
|
||||||
|
@ -32,6 +52,12 @@ Features
|
||||||
* concatenate binary data together into a file on the disk image
|
* concatenate binary data together into a file on the disk image
|
||||||
* compile assembly source into binary files if `pyatasm <https://pypi.python.org/pypi/pyatasm>`_ is installed
|
* compile assembly source into binary files if `pyatasm <https://pypi.python.org/pypi/pyatasm>`_ is installed
|
||||||
|
|
||||||
|
**Note:** The command line argument structure was changed starting with
|
||||||
|
``atrcopy`` 4.0 -- it is now based on subcommands, much like ``git`` uses ``git
|
||||||
|
pull``, ``git clone``, ``git branch``, etc. Upgrading from a version prior to
|
||||||
|
4.0 will require modification of scripts that use ``atrcopy`` 3.x-style command
|
||||||
|
line arguments.
|
||||||
|
|
||||||
|
|
||||||
Supported Formats
|
Supported Formats
|
||||||
=================
|
=================
|
||||||
|
|
Loading…
Reference in New Issue
Block a user