Skip to content

Commit

Permalink
Enhanced documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
assamite committed Nov 6, 2019
1 parent fd4f9f0 commit c59d7b6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 19 deletions.
13 changes: 3 additions & 10 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@
.. Creamas documentation master file, created by
sphinx-quickstart on Wed Nov 11 17:34:41 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Creamas - Creative Multi-Agent Systems
======================================

.. image:: _static/python-powered-w-70x28.png

Creamas is Python (3.5+) library for (creative) multi-agent systems. It was
created as a tool to research and implement multi-agent systems that exhibit
emergent and/or creative behavior in some ways. However, its main
implementations are general enough to be used for multi-agent systems with
other purposes.
Creamas is Python (3.5+) library for (creative) multi-agent systems. It is a tool to research and implement multi-agent
systems that exhibit emergent and/or creative behavior in some ways. However, its main implementations are general
enough to be used for multi-agent systems with other purposes.

Features, etc.
--------------
Expand Down
22 changes: 13 additions & 9 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
Installation
============

Creamas is developed with `Python 3.7 <https://docs.python.org/3.7/>`_,
the easiest way to install the latest distribution of Creamas is using
`pip <https://pip.pypa.io/en/stable/>`_::
Creamas is developed with `Python 3.7 <https://docs.python.org/3.7/>`_.
he easiest way to install the latest distribution of Creamas is using
`pip <https://pip.pypa.io/en/stable/>`_. Install the bare-boned version
using::

pip install creamas

Or install all the requirements using::

pip install creamas[extras]

We encourage the use of `virtual environments <https://virtualenv.readthedocs.org/en/latest/>`_
to avoid conflicting package requirements in your projects.

Expand All @@ -16,9 +21,8 @@ Installing the Development Version
If you want to use the latest development version, you can clone the repository
from git::

$>git clone https://github.com/assamite/creamas.git creamas
$>cd creamas
$>python3.7 -m venv env # create venv for python 3.7
$>source env/bin/activate # start virtualenv
$>pip install -r requirements.txt
$>pip install -r c_reqs.txt # packages using C are in different file for readthedocs
$>git clone https://github.com/assamite/creamas.git creamas
$>cd creamas
$>python3.7 -m venv env # create venv for python 3.7
$>source env/bin/activate # start virtualenv
$>pip install -r requirements.txt

0 comments on commit c59d7b6

Please sign in to comment.