Skip to content
This repository was archived by the owner on Apr 23, 2025. It is now read-only.

Commit 55ebfca

Browse files
committed
update readme
1 parent 7d24b72 commit 55ebfca

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

README.rst

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,7 @@ python4yahdlc is a Python bindings for the
1010
Dependencies
1111
============
1212

13-
To build and make the Python module work, you need the following
14-
elements:
15-
16-
- Python 3
17-
- The `setuptools <https://pypi.python.org/pypi/setuptools>`__ package
18-
19-
On Fedora
20-
---------
21-
22-
::
23-
24-
yum install python3-setuptools
25-
26-
On Debian
27-
---------
28-
29-
::
30-
31-
aptitude install python3-setuptools
13+
This software requires Python 3.
3214

3315
Installation
3416
============
@@ -49,6 +31,8 @@ From sources
4931
cd python4yahdlc
5032
python3 setup.py install
5133

34+
You need the `setuptools <https://pypi.python.org/pypi/setuptools>`_ package to execute ``setup.py``.
35+
5236
Usage
5337
=====
5438

@@ -86,6 +70,18 @@ For a more advanced use, take a look at the examples available in the
8670
`examples <https://github.com/SkypLabs/python4yahdlc/tree/master/examples>`__
8771
folder.
8872

73+
Development
74+
===========
75+
76+
Releasing a new version
77+
-----------------------
78+
79+
* Run all tests and be sure they all pass
80+
* Update the ``VERSION`` variable in ``setup.py``
81+
* Update ``MANIFEST.in`` if needed
82+
* Update the package's metadata (description, classifiers, etc) in ``setup.py`` if needed
83+
* Update ``README.rst`` if needed
84+
8985
License
9086
=======
9187

0 commit comments

Comments
 (0)