Skip to content

Commit

Permalink
PRs welcome and new tag line
Browse files Browse the repository at this point in the history
  • Loading branch information
orbeckst committed Oct 5, 2018
1 parent f94407d commit e912c20
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# MDAnalysisData

[![docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://www.mdanalysis.org/MDAnalysisData/)
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![DOI](https://zenodo.org/badge/147885122.svg)](https://zenodo.org/badge/latestdoi/147885122)

Access to data for workshops and extended tests of MDAnalysis.
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
'logo' : "logos/MDAnalysisData-logo.png",
'logo_name': True,
'logo_text_align': "left",
'description': "Datasets for MDAnalysis",
'description': "Biomolecular simulation datasets",
'github_user': "MDAnalysis",
'github_repo': "MDAnalysisData",
'github_button': False,
Expand Down
15 changes: 10 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
MDAnalysisData: MD data for testing, learning, and benchmarking
=================================================================

|doi|
|zenodo| |PRwelcome|

:Release: |release|
:Date: |today|
Expand All @@ -22,25 +22,30 @@ interface to download, cache, and access these externally hosted data
sets.

The files can be easily used with MDAnalysis_ but the package is
standalone, however, and can be used for any purpose, for instance, to
provide examples for workshops and classes.
standalone and can be used for any purpose, for instance, to
provide examples for workshops and classes, and, of course, to try out
other tools for analyzing simulations.

Datasets are released under an `open license`_ that conforms to the `Open
Definition 2.1`_ that allows free use, re-use, redistribution, modification,
separation, for any purpose and without a charge. All code
can be found in the public GitHub repository `mdanalysis/MDAnalysisData`_.

This library is **under active development**. We use `semantic
This library is *under active development*. We use `semantic
versioning`_ to indicate clearly what kind of changes you may expect
between releases. Please raise any issues or questions in the
`Issue Tracker`_. `Contributions of data sets`_ and code in the form
of pull requests are very welcome.

.. |doi| image:: https://zenodo.org/badge/147885122.svg
.. |zenodo| image:: https://zenodo.org/badge/147885122.svg
:alt: Zenodo DOI
:scale: 100%
:target: https://zenodo.org/badge/latestdoi/147885122

.. |PRwelcome| image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
:alt: PRs welcome
:target: http://makeapullrequest.com

.. _`MDAnalysis`: https://www.mdanalysis.org
.. _`mdanalysis/MDAnalysisData`: https://github.com/MDAnalysis/MDAnalysisData
.. _figshare: https://figshare.com/
Expand Down

0 comments on commit e912c20

Please sign in to comment.