Clean up README
Removed contributor list; the actual list of contributors is way too long to hold here :D
This commit is contained in:
parent
1206981107
commit
5f778f905c
60
README.md
60
README.md
@ -6,46 +6,21 @@ PyQtGraph
|
|||||||
|
|
||||||
A pure-Python graphics library for PyQt/PySide
|
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
|
||||||
|
|
||||||
<http://www.pyqtgraph.org>
|
<http://www.pyqtgraph.org>
|
||||||
|
|
||||||
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 <luke.campagnola@gmail.com>
|
|
||||||
|
|
||||||
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
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
|
||||||
* PyQt 4.7+, PySide, or PyQt5
|
* PyQt 4.7+, PySide, or PyQt5
|
||||||
* python 2.6, 2.7, or 3.x
|
* python 2.7, or 3.x
|
||||||
* NumPy
|
* NumPy
|
||||||
* For 3D graphics: pyopengl and qt-opengl
|
* For 3D graphics: pyopengl and qt-opengl
|
||||||
* Known to run on Windows, Linux, and Mac.
|
* Known to run on Windows, Linux, and Mac.
|
||||||
@ -53,33 +28,24 @@ Requirements
|
|||||||
Support
|
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
|
Installation Methods
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
|
* From pypi:
|
||||||
|
`pip install pyqtgraph`
|
||||||
* To use with a specific project, simply copy the pyqtgraph subdirectory
|
* To use with a specific project, simply copy the pyqtgraph subdirectory
|
||||||
anywhere that is importable from your project. PyQtGraph may also be
|
anywhere that is importable from your project.
|
||||||
used as a git subtree by cloning the git-core repository from github.
|
|
||||||
* To install system-wide from source distribution:
|
* To install system-wide from source distribution:
|
||||||
`$ python setup.py install`
|
`$ python setup.py install`
|
||||||
* For installation packages, see the website (pyqtgraph.org)
|
* 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
|
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.
|
||||||
|
|
||||||
Some (incomplete) documentation exists at this time.
|
The official documentation lives at http://pyqtgraph.org/documentation
|
||||||
* Easiest place to get documentation is at <http://www.pyqtgraph.org/documentation>
|
|
||||||
* 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.
|
|
||||||
|
Loading…
Reference in New Issue
Block a user