Skip to content

Commit

Permalink
Update README with JOSS badge (#58)
Browse files Browse the repository at this point in the history
* doc: add JOSS badge and citation section to README

* fix: change syntax from rst to md in CONTRIBUTING

* docs: small edit in citation in readme
  • Loading branch information
phantomas1234 authored and KristianJensen committed Jan 4, 2017
1 parent 52a632e commit 0d416e8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Contribute
==========

Contributions to optlang are very welcome. Fork optlang at `github
<http://github.com/biosustain/optlang>`_, implement your feature and send us
a pull request. Also, please use the GitHub `issue tracker <https://github.com/biosustain/optlang/issues>`_
to let us know about bugs or feature requests, or if you have problems or questions regarding optlang.
Contributions to optlang are very welcome. Fork optlang at [github](http://github.com/biosustain/optlang), implement your feature and send us
a pull request. Also, please use the GitHub [issue tracker](https://github.com/biosustain/optlang/issues)
to let us know about bugs or feature requests, or if you have problems or questions regarding optlang.
13 changes: 12 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ optlang

*Sympy based mathematical programming language*

|PyPI| |License| |Travis| |Appveyor| |Coverage Status| |Documentation Status| |DOI|
|PyPI| |License| |Travis| |Appveyor| |Coverage Status| |Documentation Status| |JOSS| |DOI|

Optlang is a Python package for solving mathematical optimization
problems, i.e. maximizing or minimizing an objective function over a set
Expand Down Expand Up @@ -108,6 +108,15 @@ Documentation
Documentation for optlang is provided at
`readthedocs.org <http://optlang.readthedocs.org/en/latest/>`__.

Citation
~~~~~~~~

Please cite |JOSS| if you use optlang in a scientific publication. In case you would like to reference a specific version of of optlang you can also include the respective Zenodo DOI (|DOI| points to the latest version).

Contributing
~~~~~~~~~~~~

Please read `<CONTRIBUTING.md>`__.

Future outlook
~~~~~~~~~~~~~~
Expand Down Expand Up @@ -138,6 +147,8 @@ also provides a good overview of the project's roadmap.
:target: https://codecov.io/gh/biosustain/optlang/branch/master
.. |Documentation Status| image:: https://readthedocs.org/projects/optlang/badge/?version=latest
:target: https://readthedocs.org/projects/optlang/?badge=latest
.. |JOSS| image:: http://joss.theoj.org/papers/cd848071a664d696e214a3950c840e15/status.svg
:target: http://joss.theoj.org/papers/cd848071a664d696e214a3950c840e15
.. |DOI| image:: https://zenodo.org/badge/5031/biosustain/optlang.svg
:target: https://zenodo.org/badge/latestdoi/5031/biosustain/optlang
.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/443yp8hf25c6748h/branch/master?svg=true
Expand Down

0 comments on commit 0d416e8

Please sign in to comment.