File	Date	Author	Commit
docs	2013-08-03	Dave Peterson	[91a3ea] * Making 1.0.0 release in preparation for work ...
endiskex	2013-08-03	Dave Peterson	[91a3ea] * Making 1.0.0 release in preparation for work ...
tests	2012-04-30	Dave Peterson	[d855ca] * Refactored internal storage for events in seq...
.hgignore	2013-08-03	Dave Peterson	[3c58ae] Merge with previous head
LICENSE.txt	2012-03-27	Dave Peterson	[eb58e1] Initial check-in of EnDiskEx at version 0.5, wh...
README.txt	2012-05-08	Dave Peterson	[0e8b0b] * Started building docs using Sphinx, and thus ...
setup.py	2012-05-08	Dave Peterson	[0e8b0b] * Started building docs using Sphinx, and thus ...

Read Me

Copyright (c) 2012 by Dave Peterson <davmp@alumni.caltech.edu>
All rights reserved.


What Is EnDiskEx?
=================

EnDiskEx is a command-line application which extracts instrument, song, and bank
data from sets of Ensoniq-formatted EPS/EPS16+/ASR disk images.  This makes it
possible to quickly and easily recreate your Ensoniq performances in the DAW
(Digital Audio Workstation) of your choice.

Find out more about EnDiskEx from the docs, or see the website at::

    https://sourceforge.net/projects/endiskex/


Installation
============

EnDiskEx is available as a binary distribution for Mac OS X 10.5, or later, and
Windows XP, or later.  For any other platform, users can download the source
distribution and install it in the typical Python manner, as long as the
pre-requisite of a Python 2.7 install with setuptools is met.

Note that EnDiskEx has not been ported or even tested for Python 3.x yet.


Install On Windows
------------------

The binary Windows distribution includes all files needed to run EnDiskEx, so
there are no pre-requisite installs necessary.

1. Download a zipped binary distribution of EnDiskEx for Windows.

2. Extract all files in the zip to whatever directory you want to install
   EnDiskEx to and run it from.  For example, ``C:\Program Files\EnDiskEx``

3. Open a Command Prompt and change to the directory you just extracted the
   distribution to.  One way to do this is to enter ``cmd`` in the ``Run...``
   field of the Windows ``Start`` menu, and when the ``Command Prompt`` window
   appears enter the following two commands::

    C:
    cd "\Program Files\EnDiskEx"

4. In that same command prompt window, execute the command ``endiskex.exe -h``
   to read the usage text and verify the install is working.

5. [OPTIONAL] If you'd like to be able to run EnDiskEx no matter what the
   current directory of your command prompt is, add the path you unpacked the
   distribution to on to the end of your machine's PATH environment variable.
   Please search online for generic instructions on setting the PATH for your
   version of Windows to learn how to do this.


Install On Mac OS X
-------------------

The binary Mac distribution includes all files needed to run EnDiskEx, so there
are no pre-requisite installs necessary.

1. Download a zipped binary distribution of EnDiskEx for Mac OS X

2. Extract all files in the zip to whatever directory you want to install
   EnDiskEx to and run it from.  For example, ``~/Applications/EnDiskEx``

3. Open the Terminal (Applications/Utilities/Terminal.app) and change
   directories to where you unzipped the distribution to.  One way to do this
   is to type ``cd`` in the Terminal window then drag the folder you unzipped
   to on to the Terminal window, and finally type ``Return``

4. In that same Terminal window, execute the command ``./endiskex -h`` to
   read the usage text and verify the install is working.

5. [OPTIONAL] If you'd like to be able to run EnDiskEx no matter what the
   current directory of your terminal is, add the directory you unpacked the
   distribution to on to the end of your system's PATH environment variable.
   This can be done by editing the ``~/.profile`` file to append the new
   directory to the line that starts with ``export PATH=``, then re-opening the
   terminal window.  Please search online for more detailed instructions if you
   need them, or your shell is not the default in a new OS X install.


Install From Source
-------------------
1. Ensure that you have a 2.7 or later install of Python available by running
   the following command in a terminal window::

        python --version

   The output must be greater than 2.7, but less than 3.0.   Do NOT attempt to
   run EnDiskEx with Python 3.0 or later.

   If need be, you can download a Python installer for most operating systems
   from the python.org website::

        http://www.python.org/download/

2. Ensure that you have "setuptools" installed in your Python 2.7 install.  This
   is most easily done (avoiding issues of multiple Python installs) by running
   the following in a terminal window.  It should print ``OK`` if setuptools is
   installed.::

        python -c "import setuptools; print 'OK'"

   If need be, you can download and install setuptools by following the
   instructions on the project page at::

        http://pypi.python.org/pypi/setuptools

3. Download a source distribution of EnDiskEx and unpack it to the directory
   of your choice.  Note that this is NOT the install location, unlike for the
   binary installs above.  Change to this directory in a terminal window.  For
   example, you might::

        cd ~/source
        tar -xzf ~/path/to/my/download/EnDiskEx-0.9.0.tar.gz
        cd EnDiskEx-0.9.0

4. Install EnDiskEx using the standard mechanism for Python applications::

        python setup.py install

   Depending on your OS and Python configuration, the actual installation step
   may require administrator privileges.  In this case, use "sudo" like::

        sudo python setup.py install

   Or get your administrator to install it for you.

5. In that same terminal window, execute the command ``endiskex -h`` to
   read the usage text and verify the install is working.


Further Info
============
See the ``docs`` sub-directory of where you unzipped to for further help using
EnDiskEx, including explanations of how to accomplish common tasks and a
revision history.