Skip to content

Commit

Permalink
Change README from .rst to .md
Browse files Browse the repository at this point in the history
  • Loading branch information
jvsguerra committed Nov 4, 2024
1 parent 64b9c29 commit 20983af
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 45 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# SERD

[![PyPI - Version](https://img.shields.io/pypi/v/SERD)](https://pypi.org/project/SERD/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/SERD)](https://pypi.org/project/SERD/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/SERD)](https://pypi.org/project/SERD/)

A Python package to detect solvent-exposed residues of a target biomolecule.

See also:

- [GitHub repository](https://github.com/LBC-LNBio/SERD/)
- [Documentation and tutorial](https://lbc-lnbio.github.io/SERD/)

## Installation

To install the latest release on [PyPI](https://pypi.org/project/SERD), run:

```bash
pip install SERD
```

Or to install the latest developmental version, run:

```bash
git clone https://github.com/LBC-LNBio/SERD.git
pip install -e SERD
```

## Citation

If you use *SERD* package, please cite:

Guerra, J. V. S., Jara, G. E., Pereira, J. G. C., & Lopes-de-Oliveira, P. S. (2022). SERD (Version v0.1.2) [Computer software]. https://github.com/LBC-LNBio/SERD.

## License

The software is licensed under the terms of the GNU General Public License version 3 (GPL3) and is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
43 changes: 0 additions & 43 deletions README.rst

This file was deleted.

6 changes: 4 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "SERD"
description = "A Python package to detect solvent-exposed residues of a target biomolecule."
readme = { file = "README.rst", content-type = "text/x-rst" }
readme = { file = "README.md", content-type = "text/markdown" }
requires-python = ">=3.10, <4"
license = { file = "LICENSE" }
authors = [
Expand All @@ -19,6 +19,7 @@ authors = [
{ name = "José G. C. Pereira" },
{ name = "Helder V. Ribeiro-Filho" },
]
maintainers = [{ name = "João V. S. Guerra", email = "[email protected]" }]
classifiers = [
"Development Status :: 4 - Beta",
"Intended Audience :: Science/Research",
Expand All @@ -29,6 +30,7 @@ classifiers = [
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3 :: Only",
]
dependencies = [
Expand All @@ -47,7 +49,7 @@ keywords = [

[project.urls]
homepage = "https://github.com/LBC-LNBio/SERD"
source = "https://github.com/LBC-LNBio/SERD/"
documentation = "https://lbc-lnbio.github.io/SERD/ "
issues = "https://github.com/LBC-LNBio/SERD/issues"

[tool.setuptools]
Expand Down

0 comments on commit 20983af

Please sign in to comment.