Skip to content

Commit

Permalink
Convert README to rst format
Browse files Browse the repository at this point in the history
  • Loading branch information
jonls committed May 21, 2015
1 parent b9a6698 commit d529efd
Showing 1 changed file with 26 additions and 16 deletions.
42 changes: 26 additions & 16 deletions README.md → README.rst
Original file line number Diff line number Diff line change
@@ -1,40 +1,48 @@
PSAMM metabolic modeling tools
==============================

[![Build Status](https://travis-ci.org/zhanglab/psamm.svg)](https://travis-ci.org/zhanglab/psamm)
[![Documentation Status](https://readthedocs.org/projects/psamm/badge/?version=latest)](https://readthedocs.org/projects/psamm/?badge=latest)
.. image:: https://travis-ci.org/zhanglab/psamm.svg?branch=develop
:alt: Build Status
:target: https://travis-ci.org/zhanglab/psamm
.. image:: https://readthedocs.org/projects/psamm/badge/?version=latest
:alt: Documentation Status
:target: https://readthedocs.org/projects/psamm/?badge=latest

Tools related to metabolic modeling, reconstruction, data parsing and
formatting, consistency checking, automatic gap filling, and model simulations.

See [NEWS](NEWS.md) for information on recent changes. The `master` branch
See NEWS_ for information on recent changes. The `master` branch
tracks the latest release while the `develop` branch is the latest version in
development. Please apply any pull requests to the `develop` branch when
creating the pull request.

.. _NEWS: NEWS.md

Install
-------

Use `pip` to install (it is recommended to use a
[Virtualenv](https://virtualenv.pypa.io/)):
Use `pip` to install (it is recommended to use a Virtualenv_):

.. code:: shell
``` shell
$ pip install git+https://github.com/zhanglab/psamm.git
```
$ pip install git+https://github.com/zhanglab/psamm.git
The `psamm-import` tool is developed in
[a separate repository](https://github.com/zhanglab/psamm-import). After
The `psamm-import` tool is developed in `a separate repository`_. After
installing PSAMM the `psamm-import` tool can be installed using:

``` shell
$ pip install git+https://github.com/zhanglab/psamm-import.git
```
.. code:: shell
$ pip install git+https://github.com/zhanglab/psamm-import.git
.. _Virtualenv: https://virtualenv.pypa.io/
.. _a separate repository: https://github.com/zhanglab/psamm-import

Documentation
-------------

The documentation for PSAMM is available at
[Read the Docs](https://psamm.readthedocs.org/).
The documentation for PSAMM is available at `Read the Docs`_.

.. _Read the Docs: https://psamm.readthedocs.org/

Software license
----------------
Expand All @@ -52,4 +60,6 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

See [LICENCE](LICENSE).
See LICENSE_.

.. _LICENSE: LICENSE

0 comments on commit d529efd

Please sign in to comment.