Browse Source

convert readme to from markdown to rest (to support pypi)

Fabian Peter Hammerle 5 years ago
parent
commit
bfb07d009b
4 changed files with 49 additions and 46 deletions
  1. 1 1
      MANIFEST.in
  2. 0 44
      README.md
  3. 47 0
      README.rst
  4. 1 1
      setup.py

+ 1 - 1
MANIFEST.in

@@ -1 +1 @@
-include README.md
+include README.rst

+ 0 - 44
README.md

@@ -1,44 +0,0 @@
-# pubmed-bibtex
-
-Python Script & Module to Generate BibTeX Entries for PubMed Publications
-
-Utilizes the API of TeXMed, a BibTeX interface for PubMed.
-
-TeXMed was written by Arne Muller
-https://www.bioinformatics.org/texmed/
-
-## Install
-
-```sh
-pip3 install --user pubmed-bibtex
-```
-
-## Usage
-
-
-```sh
-$ pubmed-bibtex 31025164
-@Article{pmid31025164,
-   Author="...",
-   Title="...",
-   Journal="...",
-   ...
-}
-```
-
-or
-
-```python
-from pubmed_bibtex import bibtex_entry_from_pmid
-print(bibtex_entry_from_pmid(123456789))
-```
-
-## Tests
-
-```sh
-pip3 install --user pipenv
-git clone https://github.com/fphammerle/pubmed-bibtex.git
-cd pubmed-bibtex
-pipenv run pylint freesurfer_surface
-pipenv run pytest --cov=freesurfer_surface
-```

+ 47 - 0
README.rst

@@ -0,0 +1,47 @@
+pubmed-bibtex
+=============
+
+Python Script & Module to Generate BibTeX Entries for PubMed
+Publications
+
+Utilizes the API of TeXMed, a BibTeX interface for PubMed.
+
+TeXMed was written by Arne Muller https://www.bioinformatics.org/texmed/
+
+Install
+-------
+
+.. code:: sh
+
+    pip3 install --user pubmed-bibtex
+
+Usage
+-----
+
+.. code:: sh
+
+    $ pubmed-bibtex 31025164
+    @Article{pmid31025164,
+       Author="...",
+       Title="...",
+       Journal="...",
+       ...
+    }
+
+or
+
+.. code:: python
+
+    from pubmed_bibtex import bibtex_entry_from_pmid
+    print(bibtex_entry_from_pmid(123456789))
+
+Tests
+-----
+
+.. code:: sh
+
+    pip3 install --user pipenv
+    git clone https://github.com/fphammerle/pubmed-bibtex.git
+    cd pubmed-bibtex
+    pipenv run pylint freesurfer_surface
+    pipenv run pytest --cov=freesurfer_surface

+ 1 - 1
setup.py

@@ -3,7 +3,7 @@ import os
 import setuptools
 
 
-with open('README.md', 'r') as readme:
+with open('README.rst', 'r') as readme:
     LONG_DESCRIPTION = readme.read()
 
 setuptools.setup(