Skip to content

Commit 5a579d8

Browse files
committed
README formatting fixes
1 parent 7e04f4e commit 5a579d8

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,55 +5,52 @@ Confluent's Apache Kafka client for Python
55
Prerequisites
66
===============
77

8-
librdkafka >=0.9.1 (or master>=2016-04-13)
9-
py.test (pip install pytest)
8+
librdkafka >=0.9.1 (or master>=2016-04-13)
9+
py.test (pip install pytest)
1010

1111

1212
Build
1313
=====
1414

15-
For Python 2:
15+
python setup.by build
1616

17-
python setup.by build
18-
19-
20-
For Python 3:
21-
22-
python3 setup.by build
2317

2418

2519
Install
2620
=======
2721
Preferably in a virtualenv:
2822

29-
pip install .
23+
pip install .
3024

3125

3226
Run unit-tests
3327
==============
3428

35-
py.test
29+
py.test
3630

3731

3832
Run integration tests
3933
=====================
40-
WARNING:: These tests require an active Kafka cluster and will make use of
41-
a topic named 'test'.
34+
**WARNING**: These tests require an active Kafka cluster and will make use of a topic named 'test'.
4235

43-
./integration_test.py <kafka-broker>
36+
./integration_test.py <kafka-broker>
4437

4538

4639

4740
Generate documentation
4841
======================
4942

50-
make docs
43+
make docs
5144

5245
or:
5346

54-
python setup.by build_sphinx
47+
python setup.by build_sphinx
48+
5549

50+
Documentation will be generated in `docs/_build/`
5651

57-
Documentation will be generated in docs/_build/
5852

53+
Examples
54+
========
5955

56+
See [examples](examples)

0 commit comments

Comments
 (0)