diff --git a/README.md b/README.md index 30268796..85f4f9e7 100644 --- a/README.md +++ b/README.md @@ -6,80 +6,46 @@ PyQtGraph A pure-Python graphics library for PyQt/PySide -Copyright 2012 Luke Campagnola, University of North Carolina at Chapel Hill +Copyright 2017 Luke Campagnola, University of North Carolina at Chapel Hill -Maintainer ----------- +PyQtGraph is intended for use in mathematics / scientific / engineering applications. +Despite being written entirely in python, the library is fast due to its +heavy leverage of numpy for number crunching, Qt's GraphicsView framework for +2D display, and OpenGL for 3D display. - * Luke Campagnola - -Contributors ------------- - - * Megan Kratz - * Paul Manis - * Ingo Breßler - * Christian Gavin - * Michael Cristopher Hogg - * Ulrich Leutner - * Felix Schill - * Guillaume Poulin - * Antony Lee - * Mattias Põldaru - * Thomas S. - * Fabio Zadrozny - * Mikhail Terekhov - * Pietro Zambelli - * Stefan Holzmann - * Nicholas TJ - * John David Reaver - * David Kaplan - * Martin Fitzpatrick - * Daniel Lidstrom - * Eric Dill - * Vincent LeSaux Requirements ------------ * PyQt 4.7+, PySide, or PyQt5 - * python 2.6, 2.7, or 3.x + * python 2.7, or 3.x * NumPy * For 3D graphics: pyopengl and qt-opengl * Known to run on Windows, Linux, and Mac. Support ------- - - Post at the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph) + + * Report issues on the [GitHub issue tracker](https://github.com/pyqtgraph/pyqtgraph/issues) + * Post questions to the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph) or [StackOverflow](https://stackoverflow.com/questions/tagged/pyqtgraph) Installation Methods -------------------- + * From pypi: + `pip install pyqtgraph` * To use with a specific project, simply copy the pyqtgraph subdirectory - anywhere that is importable from your project. PyQtGraph may also be - used as a git subtree by cloning the git-core repository from github. + anywhere that is importable from your project. * To install system-wide from source distribution: `$ python setup.py install` * For installation packages, see the website (pyqtgraph.org) - * On debian-like systems, pyqtgraph requires the following packages: - python-numpy, python-qt4 | python-pyside - For 3D support: python-opengl, python-qt4-gl | python-pyside.qtopengl Documentation ------------- -There are many examples; run `python -m pyqtgraph.examples` for a menu. +The easiest way to learn pyqtgraph is to browse through the examples; run `python -m pyqtgraph.examples` for a menu. + +The official documentation lives at http://pyqtgraph.org/documentation -Some (incomplete) documentation exists at this time. - * Easiest place to get documentation is at - * If you acquired this code as a .tar.gz file from the website, then you can also look in - doc/html. - * If you acquired this code via GitHub, then you can build the documentation using sphinx. - From the documentation directory, run: - `$ make html` - -Please feel free to pester Luke or post to the forum if you need a specific - section of documentation to be expanded.