Include README.rst (instead of README.md) for PyPI
Add Contribute section to README
This commit is contained in:
@@ -1 +1 @@
|
||||
include README.md
|
||||
include README.rst
|
||||
|
||||
24
README.rst
24
README.rst
@@ -21,7 +21,6 @@ A Python module for `semantic versioning`_. Simplifies comparing versions.
|
||||
.. |license| image:: https://img.shields.io/pypi/l/semver.svg
|
||||
:alt: Software license
|
||||
:target: https://github.com/k-bx/python-semver/blob/master/LICENSE.txt
|
||||
|
||||
.. _semantic versioning: http://semver.org/
|
||||
|
||||
Usage
|
||||
@@ -69,3 +68,26 @@ For Python 3:
|
||||
.. code-block:: bash
|
||||
|
||||
pip3 install semver
|
||||
|
||||
How to Contribute
|
||||
-----------------
|
||||
|
||||
When you make changes to the code please run the tests before pushing your
|
||||
code to your fork and opening a `pull request`_:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
python setup.py test
|
||||
|
||||
We use `py.test`_ and `tox`_ to run tests against all supported Python
|
||||
versions. All test dependencies are resolved automatically, apart from
|
||||
virtualenv, which for the moment you still may have to install manually:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install "virtualenv<14.0.0" # <14.0.0 needed for Python 3.2 only
|
||||
|
||||
|
||||
.. _pull request: https://github.com/k-bx/python-semver/pulls
|
||||
.. _py.test: http://pytest.org/
|
||||
.. _tox: http://tox.testrun.org/
|
||||
|
||||
2
setup.py
2
setup.py
@@ -33,7 +33,7 @@ setup(
|
||||
name='semver',
|
||||
version='2.4.1',
|
||||
description='Python helper for Semantic Versioning (http://semver.org/)',
|
||||
long_description=read_file('README.md'),
|
||||
long_description=read_file('README.rst'),
|
||||
author='Konstantine Rybnikov',
|
||||
author_email='k-bx@k-bx.com',
|
||||
url='https://github.com/k-bx/python-semver',
|
||||
|
||||
Reference in New Issue
Block a user