updated readme

README.md

@@ -1,18 +1,27 @@
-# python_cpp_example
+# creader
 
-Minimal example building a C++ python extension. 
+Small python package to read cluster and raw files 
 
-Useful links:
- * [Using NumPy C-API](https://numpy.org/doc/stable/user/c-info.html)
+## Getting started
+
+Run
+```bash
+export PYTHONPATH=$PWD:$PYTHONPATH
+make 
+```
+And then have a look at the examples:
+
+- [Reading cluster files](examples/ClusterFile.ipynb)
 
 
-### Build instructions
+## Build instructions
 
 **Simplified build using make** 
 ```bash
 $ make #build c extension inplace
 ```
 
+Check what is available
 ```
 $ make help
 clean                Remove the build folder and the shared library
@@ -64,4 +73,8 @@ $ export CREADER_TEST_DATA=/mnt/sls_det_storage/moench_data/cluster_reader_test/
 
 $ make test
 
-```
+```
+
+## Useful links:
+ * [Using NumPy C-API](https://numpy.org/doc/stable/user/c-info.html)
+ * [Extending Python with C](https://docs.python.org/3/extending/extending.html)