Skip to content

Commit

Permalink
make md2rst
Browse files Browse the repository at this point in the history
  • Loading branch information
cdanielmachado committed Aug 4, 2017
1 parent e5d04ee commit ce37f45
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 3 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,7 @@ dist: clean ## builds source and wheel package

install: clean ## install the package to the active Python's site-packages
python setup.py install

md2rst:
pandoc --from=markdown --to=rst --output=README.rst README.md

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Can be easily installed using **pip**:
pip install carveme
```

Additionally, you must install diamond and CPLEX.
Additionally, you must install diamond and CPLEX (please check the documentation for details).

### Credits and License

Developed at the European Molecular Biology Laboratory (2017).

Released under an Apache License.
Released under an Apache License.
34 changes: 33 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
=======
|License| |PyPI version| |Documentation Status|

CarveMe
=======

CarveMe is a python-based tool for genome-scale metabolic model
reconstruction.

Documentation
~~~~~~~~~~~~~

For more details please check: http://carveme.readthedocs.io/

Instalation
~~~~~~~~~~~

Can be easily installed using **pip**:

::

pip install carveme

Additionally, you must install diamond and CPLEX (please check the
documentation for details).

Credits and License
~~~~~~~~~~~~~~~~~~~

Developed at the European Molecular Biology Laboratory (2017).

Released under an Apache License.

.. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0
.. |PyPI version| image:: https://badge.fury.io/py/carveme.svg
:target: https://badge.fury.io/py/carveme
.. |Documentation Status| image:: http://readthedocs.org/projects/carveme/badge/?version=latest
:target: http://carveme.readthedocs.io/en/latest/?badge=latest

0 comments on commit ce37f45

Please sign in to comment.