xonsh/docs/osx.rst
2016-06-07 10:41:08 +02:00

55 lines
1 KiB
ReStructuredText

==========================
OSX Guide
==========================
Installation
============
You can install xonsh using homebrew, conda, pip, or from source.
**homebrew:**
.. code-block:: bash
$ brew install xonsh
**conda:**
.. code-block:: bash
$ conda config --add channels conda-forge
$ conda install xonsh
.. note:: For the bleeding edge development version use ``conda install -c xonsh/channel/dev xonsh``
**pip:**
.. code-block:: bash
$ pip install xonsh
**source:** Download the source `from github <https://github.com/scopatz/xonsh>`_
(`zip file <https://github.com/scopatz/xonsh/archive/master.zip>`_), then run
the following from the source directory,
.. code-block:: bash
$ python setup.py install
.. include:: add_to_shell.rst
.. include:: dependencies.rst
GNU Readline
============
On Mac OSX, it is *strongly* recommended to install the ``gnureadline`` library if using the readline shell. ``gnureadline`` can be installed via pip:
.. code-block:: bash
$ pip install gnureadline