[hdf-compass] 02/295: add readme

[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 42f3b4b7716dd2a9128d635de271821e86c62ca8
Author: John Readey <jreadey at hdfgroup.org>
Date:   Fri Jun 6 17:36:08 2014 -0700

    add readme
---
 README.txt | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..4d3cf3c
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,27 @@
+This is the source code repository for HDF Compass, a viewer program for
+HDF and HDF-related files.
+
+The project is divided into components, each of which is a top-level Python
+package:
+
+compass_viewer
+    The GUI viewer application, based on wxPython.  The file HDFCompass.py
+    is a two-line script that launches the viewer, and is provided as the
+    entry point for Py2App and PyInstaller.
+    
+compass_model
+    Defines the classes available for the pluggable data model.  This is the
+    main dependency for plugins.  The interfaces defined in compass_model are
+    implemented by plugins, and those implementations are called by the viwer
+    to populate the various views in HDFCompass (container, array, etc.).
+    
+hdf5_model
+    A basic HDF5 plugin, using h5py.
+    
+filesystem_model
+    An example filesystem plugin.  Access through the GUI by opening the
+    resource "file://localhost".
+    
+array_model
+    An example/debugging array plugin.  Access through the GUI by opening the
+    resource "array://localhost".
\ 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