Skip to content

Commit ccb2e04

Browse files
committed
Update README.md
1 parent ad0f56a commit ccb2e04

File tree

1 file changed

+37
-30
lines changed

1 file changed

+37
-30
lines changed

README.md

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,57 @@
1-
# PythonQwt
1+
# PythonQwt: Qt plotting widgets for Python
2+
3+
<img src="http://pythonhosted.org/PythonQwt/_images/panorama.png">
24

35
## Purpose and Motivation
46

5-
The ``PythonQwt`` project was initiated to solve -at least temporarily-
6-
the obsolescence issue of `PyQwt` (the Python-Qwt C++ bindings library)
7-
which is no longer maintained. The idea was to translate the original
8-
Qwt C++ code to Python and then to optimize some parts of the code by
9-
writing new modules based on NumPy and other libraries.
7+
The `PythonQwt` project was initiated to solve -at least temporarily- the
8+
obsolescence issue of `PyQwt` (the Python-Qwt C++ bindings library) which is
9+
no longer maintained. The idea was to translate the original Qwt C++ code to
10+
Python and then to optimize some parts of the code by writing new modules
11+
based on NumPy and other libraries.
1012

11-
The ``PythonQwt`` package consists of a single Python package named
12-
`qwt` and of a few other files (examples, doc, ...).
13+
The `PythonQwt` package consists of a single Python package named `qwt` and
14+
of a few other files (examples, doc, ...).
1315

1416
## Copyrights
1517

1618
#### 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
19-
translation and optimization
20-
- Copyright © 2015 Pierre Raybaut, for the PythonQwt specific and
21-
exclusive Python material
19+
- Copyright © 2002 Uwe Rathmann, for the original Qwt C++ code
20+
- Copyright © 2015 Pierre Raybaut, for the Qwt C++ to Python translation and
21+
optimization
22+
- Copyright © 2015 Pierre Raybaut, for the PythonQwt specific and exclusive
23+
Python material
2224

2325
#### PyQt, PySide and Python2/Python3 compatibility modules
24-
- Copyright © 2009-2013 Pierre Raybaut
25-
- Copyright © 2013-2015 The Spyder Development Team
26+
- Copyright © 2009-2013 Pierre Raybaut
27+
- Copyright © 2013-2015 The Spyder Development Team
2628

2729
#### Some examples
28-
- Copyright © 2003-2009 Gerard Vermeulen, for the original PyQwt code
29-
- Copyright © 2015 Pierre Raybaut, for the PyQt5/PySide port and
30-
further developments (e.g. ported to PythonQwt API)
30+
- Copyright © 2003-2009 Gerard Vermeulen, for the original PyQwt code
31+
- Copyright © 2015 Pierre Raybaut, for the PyQt5/PySide port and further
32+
developments (e.g. ported to PythonQwt API)
3133

3234
## License
3335

34-
The `qwt` Python package was partly (>95%) translated from Qwt C++
35-
library: the associated code is distributed under the terms of the LGPL
36-
license. The rest of the code was either wrote from scratch or strongly
37-
inspired from MIT licensed third-party software.
38-
See included LICENSE file for more details about licensing terms.
36+
The `qwt` Python package was partly (>95%) translated from Qwt C++ library:
37+
the associated code is distributed under the terms of the LGPL license. The
38+
rest of the code was either wrote from scratch or strongly inspired from MIT
39+
licensed third-party software.
40+
41+
See included [LICENSE](LICENSE) file for more details about licensing terms.
3942

4043
## Overview
4144

42-
The `qwt` package is a pure Python implementation of `Qwt` C++ library
43-
with the following limitations.
45+
The `qwt` package is a pure Python implementation of `Qwt` C++ library with
46+
the following limitations.
4447

4548
The following `Qwt` classes won't be reimplemented in `qwt` because more
4649
powerful features already exist in `guiqwt`: `QwtPlotZoomer`,
4750
`QwtCounter`, `QwtEventPattern`, `QwtPicker`, `QwtPlotPicker`.
4851

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` and `QwtPlotCurve`.
52+
Only the following plot items are currently implemented in `qwt` (the only
53+
plot items needed by `guiqwt`): `QwtPlotItem` (base class), `QwtPlotItem`,
54+
`QwtPlotMarker`, `QwtPlotSeriesItem` and `QwtPlotCurve`.
5255

5356
See "Overview" section in [documentation](http://pythonhosted.org/PythonQwt/)
5457
for more details on API limitations when comparing to Qwt.
@@ -65,7 +68,7 @@ for more details on API limitations when comparing to Qwt.
6568

6669
From the source package:
6770

68-
```python
71+
```bash
6972
python setup.py install
7073
```
7174

@@ -78,4 +81,8 @@ from qwt import tests
7881
tests.run()
7982
```
8083

81-
or from the command line: `PythonQwt-tests`.
84+
or from the command line:
85+
86+
```bash
87+
PythonQwt-tests
88+
```

0 commit comments

Comments
 (0)