Skip to content
This repository has been archived by the owner on Apr 4, 2019. It is now read-only.

Commit

Permalink
docs(installation): Suggest homebrew formula on macOS
Browse files Browse the repository at this point in the history
  • Loading branch information
kylef committed Jun 18, 2018
1 parent ba52a77 commit 996c1ae
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,19 @@ This is an internal tool for supporting development workflow inside `Apiary <htt
Installation
------------

``pip install blackbelt`` if you can, ``easy_install blackbelt`` if
you must (Mac OS X default).
On macOS, the easiest way to install blackbelt is via `Homebrew <https://brew.sh/>`_::

MacOs and Python3 need use `Homebrew <https://brew.sh/>`_
$ brew install apiaryio/formulae/blackbelt

``brew install python3 && pip3 install blackbelt``
On other platforms you can install Blackbelt with ``pip install blackbelt`` providing you have Python and pip installed. Consult your platform for documentation on how to install Python and pip.

.. note::
Python 3.6+ is default now and Python 2.7 will be deprecated.

-----
Setup
-----

With that, you should have ``bb`` command. Run interactive ``bb init`` and follow instructions. This is going to connect to services we are using in Apiary for futher interaction:

* GitHub
Expand All @@ -45,7 +48,14 @@ See `click's documentation <http://click.pocoo.org/3/bashcomplete/>`_ for more i
Upgrade
-------

``pip install -U blackbelt``
If you used Homebrew on macOS, use::

$ brew update
$ brew upgrade

Otherwise::

$ pip install -U blackbelt

If you get error along the lines of::

Expand Down

0 comments on commit 996c1ae

Please sign in to comment.