From 47c55ed4e3f7f4d4da839c5a279df6848149c8ed Mon Sep 17 00:00:00 2001 From: Guillaume Poulin Date: Thu, 12 Sep 2013 14:22:26 +0800 Subject: [PATCH] Update README.md correct markdown --- README.md | 66 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 37 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index f1ae9f7d..23f47ea7 100644 --- a/README.md +++ b/README.md @@ -2,55 +2,63 @@ PyQtGraph ========= A pure-Python graphics library for PyQt/PySide + Copyright 2012 Luke Campagnola, University of North Carolina at Chapel Hill -http://www.pyqtgraph.org + + Maintainer ---------- - * Luke Campagnola ('luke.campagnola@%s.com' % 'gmail') + + * Luke Campagnola ('luke.campagnola@%s.com' % 'gmail') Contributors ------------ - * Megan Kratz - * Paul Manis - * Ingo Breßler - * Christian Gavin - * Michael Cristopher Hogg - * Ulrich Leutner - * Felix Schill - * Guillaume Poulin + + * Megan Kratz + * Paul Manis + * Ingo Breßler + * Christian Gavin + * Michael Cristopher Hogg + * Ulrich Leutner + * Felix Schill + * Guillaume Poulin Requirements ------------ - PyQt 4.7+ or PySide - python 2.6, 2.7, or 3.x - numpy, scipy - For 3D graphics: pyopengl - Known to run on Windows, Linux, and Mac. + + * PyQt 4.7+ or PySide + * python 2.6, 2.7, or 3.x + * numpy, scipy + * For 3D graphics: pyopengl + * Known to run on Windows, Linux, and Mac. 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 -------------------- - * 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 - * To install system-wide from source distribution: - `$ python setup.py install` - * For instalation packages, see the website (pyqtgraph.org) + * To install system-wide from source distribution: + `$ python setup.py install` + * For instalation packages, see the website (pyqtgraph.org) Documentation ------------- - There are many examples; run `python -m pyqtgraph.examples` for a menu. - Some (incomplete) documentation exists at this time. - * 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 + +There are many examples; run `python -m pyqtgraph.examples` for a menu. + +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. + * 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. + +Please feel free to pester Luke or post to the forum if you need a specific + section of documentation.