Update documentation

Author: adevress

README

@@ -1,32 +1,36 @@
-The HighFive library - HDF5 C++
+HighFive - HDF5 header-only C++ Library
 
-** Brief
-Header-only wrapper to libhdf5 ( HDF5 library ) for C++
+# Brief
+
+HighFive is a modern C++/C++11 friendly interface for libhdf5. 
+
+HighFive supports STL vector/string, Boost::UBLAS and Boost::Multi-array. It handles C++ from/to HDF5 automatic type mapping. 
+HighFive does not require an additional library and supports both HDF5 thread safety and Parallel HDF5 (contrary to the official hdf5 cpp)
 
-** Dependencies
-- libHDF5
-- (optional) boost >= 1.41 
 
+## Design
+- Simple C++-ish minimalist interface
+- No other dependency than libhdf5  
+- Zero overhead
+- Support C++11 ( compatible with C++98 )
 
-** Design
-- Simple for simple things, advanced for advance things
-- Use only what you need: no other dependency than libhdf5 needed 
-- Support C++11
-- Compatible with C++98
-- Support for boost::multi_array and boost::ublas::matrix accessible on demand
+
+## Dependencies
+- libhdf5
+- (optional) boost >= 1.41 
 
 
-** Usage
+## Usage
 
-**
+```c++
     using namespace HighFive;
     // we create a new hdf5 file
-    File file(FILE_NAME, File::ReadWrite | File::Create | File::Truncate);
+    File file("/tmp/new_hdf5_file.h5", File::ReadWrite | File::Create | File::Truncate);
 
     std::vector<int> data(50, 1);
 
     // lets create a dataset of native interger with the size of the vector 'data'
-    DataSet dataset = file.createDataSet<int>(DATASET_NAME,  DataSpace::From(data));
+    DataSet dataset = file.createDataSet<int>("/dataset_one",  DataSpace::From(data));
 
     // lets write our vector of int to the HDF5 dataset
     dataset.write(data);
@@ -35,32 +39,40 @@ Header-only wrapper to libhdf5 ( HDF5 library ) for C++
     std::vector<int> result
     dataset.read(result);
 
-** 
+```
 
 See examples/  sub-directory for more infos
 
-** Compile
-No compilation needed for usage, just add highfive/include/ to your include path
+## Compile with HighFive
+
+c++ -o program -I/path/to/highfive/include source.cpp  -lhdf5
+
+
+## Test Compilation
+Remember: Compilation is not required. Used only for unit test and examples
+
+mkdir build; pushd build   
+cmake ../   
+make   
+make test   
 
-- test compilation
-mkdir build; pushd build
-cmake ../
-make
-make test
 
+## Feature support
+    - Create/read/write file,  dataset, group, dataspace.
+    - Automatic memory management / ref counting
+    - Automatic convertion of  std::vector and nested std::vector from/to any dataset with basic types
+    - Automatic convertion of std::string to/from variable length string dataset
+    - selection() / slice support
+    - support HDF5 attributes
 
-** Feature support
-- Create/read/write file,  dataset, group, datasapce.
-- Automatic memory management / ref counting
-- Automatic convertion of  std::vector and nested std::vector from/to any dataset with basic types
-- Automatic convertion of std::string to/from variable length string dataset
 
+## Contributors
+Adrien Devresse <[email protected]> - Blue Brain Project   
+Ali Can Demiralp <[email protected]>   
+Stefan Eilemann <[email protected]> - Blue Brain Project  
 
-** Contributors
-Adrien Devresse <[email protected]> - Blue Brain Project
-Ali Can Demiralp <[email protected]> 
 
-** License
+## License
 LGPLv2.1+
 
 

doc/build.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+pandoc -s -S -c doc/github-pandoc.css  ./README -o index.html