Skip to content

Commit

Permalink
Add a README
Browse files Browse the repository at this point in the history
  • Loading branch information
velovix committed Aug 17, 2020
1 parent 6b0aee1 commit 8e89a39
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
==============
BrainFrame CLI
==============

The BrainFrame CLI is a tool for installing and managing a BrainFrame server.

Installation
------------

The CLI is installable with Pip. Ubuntu 18.04 and 20.04 are officially
supported, but other versions of Linux are expected to work as well.

On Ubuntu:

.. code-block::
sudo -H pip3 install brainframe-cli
Upgrading
---------

Pip can be used to upgrade to a new version.

.. code-block::
sudo -H pip3 install --upgrade brainframe-cli
Usage
-----

To install BrainFrame, simply run the ``install`` command as root:

.. code-block::
sudo brainframe install
BrainFrame can then be controlled like a normal Docker Compose application
using the ``compose`` command, which can be run from any directory.

.. code-block::
brainframe compose up -d
For more information, take a look at the `Getting Started guide`_.

.. _`Getting Started guide`: https://aotu.ai/docs/getting_started/

0 comments on commit 8e89a39

Please sign in to comment.