xonsh/docs/osx.rst
Gil Forsyth e363192d67 remove bash (from the docs)
swapping out all instances of `bash` code-blocks for `console`
code-blocks for better syntax highlighting
2016-08-18 14:18:57 -04:00

60 lines
1.1 KiB
ReStructuredText

==========================
OSX Guide
==========================
Installation
============
You can install xonsh using homebrew, conda, pip, or from source.
**homebrew:**
.. code-block:: console
$ brew install xonsh
**conda:**
.. code-block:: console
$ conda config --add channels conda-forge
$ conda install xonsh
**pip:**
.. code-block:: console
$ pip3 install xonsh
**source:** Download the source `from github <https://github.com/xonsh/xonsh>`_
(`zip file <https://github.com/xonsh/xonsh/archive/master.zip>`_), then run
the following from the source directory,
.. code-block:: console
$ python3 setup.py install
Extras for OSX
==============
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:: console
$ pip3 install gnureadline
Xonsh has support for using bash completion files on the shell, to use it you need to install the bash-completion package
.. code-block:: console
$ brew install bash-completion
.. include:: add_to_shell.rst
.. include:: dependencies.rst