add a README that describe the project. draft
authoralain leufroy <alain@leufroy.fr>
Fri, 29 Mar 2013 23:49:20 +0100
changeset 54 c8928da2166e
parent 53 497beda7935a
child 55 739909282e6a
add a README that describe the project.
README
setup.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri Mar 29 23:49:20 2013 +0100
@@ -0,0 +1,15 @@
+H5FS is a mountable Linux virtual file system that allows user to read the
+content of HDF5 as if they were real files.
+
+In fact, HDF5 simplifies the file structure to include only two major types of
+object:
+
+* Datasets, which are multidimensional arrays of a homogenous type
+
+* Groups, which are container structures which can hold datasets and other
+  groups
+
+This results in a truly hierarchical, filesystem-like data format as resources
+in an HDF5 file are even accessed using the POSIX-like syntax
+/path/to/resource. By this way a virtual file system that exposes to the user
+the hierarchical data seems natural.
--- a/setup.py	Thu Apr 04 14:01:04 2013 +0200
+++ b/setup.py	Fri Mar 29 23:49:20 2013 +0100
@@ -8,7 +8,8 @@
     version = '0.1.0',
     author = 'alain leufroy',
     author_email = 'alain.leufroy@logilab.fr',
-    description = 'A virtual filesystem that exposes the content of an HDF5 file',
+    description = 'A virtual filesystem that exposes the content of HDF5 files',
+    long_description = open("README").read(),
     py_modules = ['h5fs'],
     scripts = ['bin/h5fs'],
 )