From 85572d5f7a09ca7d42ac4479746584ba2c530676 Mon Sep 17 00:00:00 2001 From: Guillaume Poulin Date: Thu, 12 Sep 2013 14:01:52 +0800 Subject: [PATCH] Convert README to markdown for better github presentation --- README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.txt | 47 --------------------------------------------- 2 files changed, 56 insertions(+), 47 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 00000000..f1ae9f7d --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +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') + +Contributors +------------ + * 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. + +Support +------- + 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 + 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) + +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 + 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. diff --git a/README.txt b/README.txt deleted file mode 100644 index d03c6c77..00000000 --- a/README.txt +++ /dev/null @@ -1,47 +0,0 @@ -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') - -Contributors: - 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. - -Support: - 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 - 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) - -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 - doc/html. - - If you acquired this code via BZR, 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.