Skip to content

Commit 02bf7e4

Browse files
committed
README: fixes some md issues + adds limitations
1 parent 98e6ab0 commit 02bf7e4

File tree

1 file changed

+29
-40
lines changed

1 file changed

+29
-40
lines changed

README.md

Lines changed: 29 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
python-qwt
2-
==========
1+
# python-qwt
32

4-
Purpose and Motivation
5-
----------------------
3+
## Purpose and Motivation
64

75
The ``python-qwt`` project was initiated to solve -at least temporarily-
86
the obsolescence issue of `PyQwt` (the Python-Qwt C++ bindings library)
@@ -13,69 +11,60 @@ writing new modules based on NumPy and other libraries.
1311
The ``python-qwt`` package consists of a single Python package named
1412
`qwt` and of a few other files (examples, doc, ...).
1513

14+
## Copyrights
1615

17-
Copyrights
18-
----------
19-
20-
### Main code base ###
21-
Copyright (c) 2002 Uwe Rathmann, for the original Qwt C++ code
22-
Copyright (c) 2015 Pierre Raybaut, for the Qwt C++ to Python
16+
#### Main code base
17+
- Copyright © 2002 Uwe Rathmann, for the original Qwt C++ code
18+
- Copyright © 2015 Pierre Raybaut, for the Qwt C++ to Python
2319
translation and optimization
24-
Copyright (c) 2015 Pierre Raybaut, for the python-qwt specific and
20+
- Copyright © 2015 Pierre Raybaut, for the python-qwt specific and
2521
exclusive Python material
2622

27-
### PyQt, PySide and Python2/Python3 compatibility modules ###
28-
Copyright (c) 2009-2013 Pierre Raybaut
29-
Copyright (c) 2013-2015 The Spyder Development Team
23+
#### PyQt, PySide and Python2/Python3 compatibility modules
24+
- Copyright © 2009-2013 Pierre Raybaut
25+
- Copyright © 2013-2015 The Spyder Development Team
3026

31-
### Some examples ###
32-
Copyright (C) 2003-2009 Gerard Vermeulen, for the original PyQwt code
33-
Copyright (c) 2015 Pierre Raybaut, for the PyQt5/PySide port and
27+
#### Some examples
28+
- Copyright © 2003-2009 Gerard Vermeulen, for the original PyQwt code
29+
- Copyright © 2015 Pierre Raybaut, for the PyQt5/PySide port and
3430
further developments (e.g. ported to python-qwt API)
3531

36-
37-
License
38-
-------
32+
## License
3933

4034
The `qwt` Python package was partly (>95%) translated from Qwt C++
4135
library: the associated code is distributed under the terms of the LGPL
4236
license. The rest of the code was either wrote from scratch or strongly
4337
inspired from MIT licensed third-party software.
4438
See included LICENSE file for more details about licensing terms.
4539

46-
47-
Overview
48-
--------
40+
## Overview
4941

5042
The `qwt` package is a pure Python implementation of Qwt C++ library with
5143
the following limitations.
5244

53-
The following `Qwt` classes won't be reimplemented in `qwt` because most
54-
powerful features already exist in `guiqwt`:
55-
- QwtPlotZoomer
56-
- QwtCounter
57-
- QwtEventPattern
58-
- QwtPicker
59-
- QwtPlotPicker
45+
The following `Qwt` classes won't be reimplemented in `qwt` because more
46+
powerful features already exist in `guiqwt`: `QwtPlotZoomer`,
47+
`QwtCounter`, `QwtEventPattern`, `QwtPicker`, `QwtPlotPicker`.
6048

61-
QwtClipper is not implemented yet (and it will probably be very difficult
62-
or impossible to implement it in pure Python without performance issues).
63-
As a consequence, when zooming in a plot curve, the entire curve is still
64-
painted (in other words, when working with large amount of data, there is
65-
no performance gain when zooming in).
49+
Only the following plot items are currently implemented in `qwt` (the
50+
only plot items needed by `guiqwt`): `QwtPlotItem` (base class),
51+
`QwtPlotItem`, `QwtPlotMarker`, `QwtPlotSeriesItem`, `QwtPlotHistogram`,
52+
`QwtPlotCurve`
6653

54+
The `QwtClipper` class is not implemented yet (and it will probably be
55+
very difficult or even impossible to implement it in pure Python without
56+
performance issues). As a consequence, when zooming in a plot curve, the
57+
entire curve is still painted (in other words, when working with large
58+
amount of data, there is no performance gain when zooming in).
6759

68-
Dependencies
69-
------------
60+
## Dependencies
7061

7162
### Requirements ###
7263
- Python >=2.6 or Python >=3.0
7364
- PyQt4 >=4.4 or PyQt5 >= 5.5
7465
- NumPy >= 1.5
7566

76-
77-
Installation
78-
------------
67+
## Installation
7968

8069
From the source package:
8170

0 commit comments

Comments
 (0)