Skip to content

Commit

Permalink
Add link to docs on README.
Browse files Browse the repository at this point in the history
  • Loading branch information
prabhuramachandran committed Aug 29, 2018
1 parent 728e610 commit 0dffcf1
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
automan: a simple automation framework
--------------------------------------

|Travis Status| |Appveyor Status| |Coverage Status|
|Travis Status| |Appveyor Status| |Coverage Status| |Documentation Status|

.. |Travis Status| image:: https://travis-ci.org/pypr/automan.svg?branch=master
:target: https://travis-ci.org/pypr/automan
:target: https://travis-ci.org/pypr/automan

.. |Appveyor Status| image:: https://ci.appveyor.com/api/projects/status/82mxewh71wodobdf
:target: https://ci.appveyor.com/project/prabhuramachandran/automan
:target: https://ci.appveyor.com/project/prabhuramachandran/automan

.. |Coverage Status| image:: https://codecov.io/gh/pypr/automan/branch/master/graph/badge.svg
:target: https://codecov.io/gh/pypr/automan

.. |Documentation Status| image:: https://readthedocs.org/projects/automan/badge/?version=latest
:target: https://automan.readthedocs.io/en/latest/?badge=latest


This framework allows you to automate your computational pipelines.
``automan`` is open source and distributed under the terms of the 3-clause BSD
Expand Down Expand Up @@ -48,8 +51,10 @@ or::
Documentation
-------------

Complete documentation for this framework is in the form of a paper that is
currently under review, you can see a draft here: https://arxiv.org/abs/1712.04786
Documentation for this project is available at https://automan.rtfd.io

There is also a paper that has been accepted but not yet in print, you can see
a draft here: https://arxiv.org/abs/1712.04786

The paper motivates and describes the software and how you can use it.

Expand Down

0 comments on commit 0dffcf1

Please sign in to comment.