Skip to content

Commit

Permalink
Update docs for binaries and 0.9.5
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmreed committed Mar 25, 2020
1 parent d5de607 commit 160aebe
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Amaxa is designed to replace complex, error-prone workflows that manipulate data

Amaxa is free and open source software, distributed under the BSD License. Amaxa is by `David Reed <https://ktema.org>`_, (c) 2019-2020.

Documentation on `ReadTheDocs <https://amaxa.readthedocs.io>`_ covers the development version of Amaxa (as found in the ``master`` branch). For documentation that covers the latest versions of Amaxa available on PyPI, please view the README found on the `PyPI listing <https://pypi.org/project/amaxa/>`_.
Documentation for Amaxa is available on `ReadTheDocs <https://amaxa.readthedocs.io>`_. The project is developed on `GitHub <https://github.com/davidmreed/amaxa>`_.

What Does Amaxa Mean?
---------------------
Expand Down
10 changes: 6 additions & 4 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,24 @@ Installing Amaxa
Installation
************

Amaxa requires Python 3.7 or 3.8.
Amaxa supports Python 3.6.1 or greater.

Prebuilt, single-binary versions of Amaxa (created using ``PyInstaller``) are available in current `releases <https://github.com/davidmreed/amaxa/releases>`_ for Linux, Mac OS X, and Windows 10.

To install Amaxa using ``pip``, execute

.. code-block:: shell
$ pip install amaxa
Make sure to invoke within a Python 3.7+ virtual environment or specify Python 3.7 or greater as required by your operating system.
Make sure to invoke within a Python 3.6+ virtual environment or specify Python 3.6 or greater as required by your operating system.

Amaxa is operating system-agnostic. It has been tested primarily on Linux. Amaxa has been known to work in some Windows environments (such as MINGW), but is not actively tested on Windows.
Amaxa is operating system-agnostic but is primarily tested on Linux.

Development
***********

To start working with Amaxa in a virtual environment, clone the Git repository. Amaxa's primary repository is on `GitHub <https://github.com/davidmreed/amaxa>`_, and is mirrored on `GitLab <https://gitlab.com/davidmreed/amaxa>`_.
To start working with Amaxa in a virtual environment, clone the Git repository. Amaxa's repository is on `GitHub <https://github.com/davidmreed/amaxa>`_, and is mirrored on `GitLab <https://gitlab.com/davidmreed/amaxa>`_.

Then, create a virtual environment for Amaxa and install:

Expand Down

0 comments on commit 160aebe

Please sign in to comment.