8000 Rewritten the README in rst format · netzulo/python-io-chunks@06be96a · GitHub
[go: up one dir, main page]
Skip to content

Commit 06be96a

Browse files
TerseusTerseus
committed
Rewritten the README in rst format
1 parent 339c428 commit 06be96a

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

‎README.md renamed to ‎README.rst

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
1-
# io-chunks
1+
io-chunks
2+
#########
23

34
Stream chunks compatible with IO standard library
45

5-
## Installing
66

7-
```
8-
pip install io-chunks
9-
```
7+
Installing
8+
==========
109

11-
## Python version
10+
.. code-block:: bash
11+
pip install io-chunks
12+
13+
14+
Python version
15+
==============
1216

1317
Tested in Python 3.5.
1418

15-
## 8000 Running the tests
1619

17-
Run the tests with `nose`:
20+
Running the tests
21+
=================
22+
23+
Run the tests with ``nose``:
24+
25+
.. code-block:: bash
26+
nosetests
1827
19-
```
20-
nosetests
21-
```
2228
23-
## TODO
29+
TODO
30+
====
2431

25-
* Rewrite README in ReStructured Text.
2632
* Upload package to pypi so the installing instructions works.
2733
* Automated testing in Python 2.7 and 3.x
2834
* Write *some* examples and description.

0 commit comments

Comments
 (0)
0