[hdf-compass] 66/295: Basic README for github

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to branch debian/master
in repository hdf-compass.

commit da0e78570c52f766006518de9d76b6db9dd1474b
Author: Andrew Collette <andrew.collette at gmail.com>
Date:   Mon Apr 27 10:34:35 2015 -0600

    Basic README for github
---
 README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 565287b..573d401 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,50 @@
-hdf-compass
+HDF Compass
 ===========
+
+Welcome to the project!  HDF Compass is an experimental viewer program for
+HDF5 and related formats, designed to complement other more complex
+applications like HDFView.  Strong emphasis is placed on clean minimal design,
+and maximum extensibility through a plugin system for new formats.
+
+HDF Compass is written in Python, but ships as a native application on
+Windows, OS X, and Linux, by using PyInstaller and Py2App to package the app.
+
+Bug reports and pull requests are welcome!  For non-trivial PRs please
+open an issue first, so the core developers can give feedback on your idea.
+
+Development Environment
+-----------------------
+
+You will need:
+
+* Python 2.7
+* NumPy
+* Matplotlib
+* wxPython Phoenix (2.9.5.0 or later)
+* h5py
+
+For packaging the app:
+
+* Py2App (OS X)
+* PyInstaller (Linux & Windows)
+
+Running the Program
+-------------------
+
+    $ python HDFCompass.py
+    
+Packaging on OS X
+-----------------
+
+    $ python setup.py py2app
+    
+Packaging on Windows
+--------------------
+
+    $ pyinstaller HDFCompass.spec
+    
+Other info
+----------
+
+* Homepage: http://github.com/HDFGroup/hdf-compass
+* License: BSD-like HDF Group license (See COPYING)
\ No newline at end of file

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/hdf-compass.git