From 34afc58dc1f1bbe2b36584c51dd68101d99598c3 Mon Sep 17 00:00:00 2001
From: Marina Ganeva <m.ganeva@fz-juelich.de>
Date: Fri, 6 Dec 2013 13:01:34 +0100
Subject: [PATCH] README file for the c++ example.

---
 Examples/cpp/README | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 Examples/cpp/README

diff --git a/Examples/cpp/README b/Examples/cpp/README
new file mode 100644
index 00000000000..6f61b5671a4
--- /dev/null
+++ b/Examples/cpp/README
@@ -0,0 +1,34 @@
+BornAgain simulation example using C++ interface.
+
+This folder contains: 
+
+--- ex001_CylindersAndPrisms ---
+    Mixture of cylinders and prisms without interference.
+    Corresponds to IsGISAXS example #1.
+
+How to compile and run the example.
+-------------------------------------------------------------------------------
+1) Install third party software
+-------------------------------------------------------------------------------
+Required:
+* compilers: clang  versions >=3.1 or GCC versions >=4.2
+* cmake >=2.8
+* boost library >=1.48
+* Eigen3 library >=3.1.0
+* BornAgain library
+* ROOT framework (to plot the result)
+
+-------------------------------------------------------------------------------
+2) Building with CMake
+-------------------------------------------------------------------------------
+mkdir <build_dir>
+cd <build_dir>
+cmake <source_dir> 
+make
+
+-------------------------------------------------------------------------------
+3) Running the simulation
+-------------------------------------------------------------------------------
+cd <build_dir>
+./CylindersAndPrisms
+
-- 
GitLab