x/opencafe
Code Issues Proposed changes

Taking a quick stab at the install docs.

Browse Source 
Will need to add more here, but this will get us started.

Closes GitHub Issue #7
Change-Id: Ieac7bc0e3f21e1df9cc63c91c3a8b62371b94e82
This commit is contained in:
John Vrbanac 2014-01-31 17:46:20 -06:00
parent 9f493b9b8f
commit 916d666923
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/source/getting_started/install.rst
View File

@ -2,3 +2,44 @@
Installing OpenCAFE Installing OpenCAFE
==================== ====================
Currently OpenCAFE is not available on PyPI *(coming soon)*. As a result, you will need to install via pip through either cloning the repository or downloading a snapshot archive.
Install OpenCAFE
===============================
The preferred method of installing OpenCAFE is using pip.
.. code-block:: bash
# Clone Repository
git clone git@github.com:CafeHub/opencafe.git
# Change current directory
cd opencafe
# Install OpenCAFE
pip install . --upgrade
If you don't wish to use Git, then you can `download <https://github.com/CafeHub/opencafe/archive/master.zip>`_ and uncompress a snapshot archive in place of cloning the repository.
Installing Plugins
====================
When you install OpenCAFE, you only install the base framework. All other functionality is packaged into plugins.
Install
---------
To install a plugin, use the following command:
.. code-block:: bash
# Installing the mongo plugin
cafe-config plugins install mongo
List
---------
Retrieves a list of all plugins available to install
.. code-block:: bash
cafe-config plugins list