ASCEE/pyqtgraph
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #3 from gpoulin/master

Browse Source 
Update README.md
This commit is contained in:
Luke Campagnola 2013-09-11 23:30:32 -07:00
commit 5ad39c2509
1 changed files with 37 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -2,55 +2,63 @@ 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 2012 Luke Campagnola, University of North Carolina at Chapel Hill
http://www.pyqtgraph.org
<http://www.pyqtgraph.org>
Maintainer Maintainer
---------- ----------
* Luke Campagnola ('luke.campagnola@%s.com' % 'gmail')
* Luke Campagnola ('luke.campagnola@%s.com' % 'gmail')
Contributors Contributors
------------ ------------
* Megan Kratz
* Paul Manis * Megan Kratz
* Ingo Breßler * Paul Manis
* Christian Gavin * Ingo Breßler
* Michael Cristopher Hogg * Christian Gavin
* Ulrich Leutner * Michael Cristopher Hogg
* Felix Schill * Ulrich Leutner
* Guillaume Poulin * Felix Schill
* Guillaume Poulin
Requirements Requirements
------------ ------------
PyQt 4.7+ or PySide
python 2.6, 2.7, or 3.x * PyQt 4.7+ or PySide
numpy, scipy * python 2.6, 2.7, or 3.x
For 3D graphics: pyopengl * numpy, scipy
Known to run on Windows, Linux, and Mac. * For 3D graphics: pyopengl
* Known to run on Windows, Linux, and Mac.
Support Support
------- -------
Post at the mailing list / forum:
https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph Post at the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph)
Installation Methods Installation Methods
-------------------- --------------------
* 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 anywhere that is importable from your project
* To install system-wide from source distribution: * To install system-wide from source distribution:
`$ python setup.py install` `$ python setup.py install`
* For instalation packages, see the website (pyqtgraph.org) * For instalation packages, see the website (pyqtgraph.org)
Documentation Documentation
------------- -------------
There are many examples; run `python -m pyqtgraph.examples` for a menu.
Some (incomplete) documentation exists at this time. There are many examples; run `python -m pyqtgraph.examples` for a menu.
* Easiest place to get documentation is at
http://www.pyqtgraph.org/documentation Some (incomplete) documentation exists at this time.
* If you acquired this code as a .tar.gz file from the website, then you can also look in * 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. doc/html.
* If you acquired this code via GitHub, then you can build the documentation using sphinx. * If you acquired this code via GitHub, then you can build the documentation using sphinx.
From the documentation directory, run: From the documentation directory, run:
`$ make html` `$ make html`
Please feel free to pester Luke or post to the forum if you need a specific
section of documentation. Please feel free to pester Luke or post to the forum if you need a specific
section of documentation.