diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..1b2211df0790214715591d9b6986c768d12365cf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build* diff --git a/README.md b/README.md index 14888ffa6adfc69e122cf9cf2ed848373d9ccf79..26595acc50d864276a991076b5b233fcc550143d 100644 --- a/README.md +++ b/README.md @@ -1 +1,51 @@ # SimulatedEbsTm +Simulated Tune Monoitor device used in the frramework of the Elettra 2.0 simulator + +## Elettra 2.0 fork + +The class is a fork from the original ESRF implementation. Reasons for forking: + 1) Elettra 2.0 has some differences in the combined magnets composition (set of multipoles) and in the excitation schemes for combined magnets. + 2) We must use our local gitlab repository in order to use the INAU deployment system. + +## Cloning -- originale sources + +To clone this class, type + +``` +git clone git@gitlab.esrf.fr:accelerators/Simulators/EbsSimulator/SimulatedEbsTm.git +``` + +## Documentation + +Poo generated documentation in **doc_html** folder + +## Building and Installation + +### Dependencies + +The project has the following dependencies. + +#### Project Dependencies + +* Tango Controls 9 or higher. +* omniORB release 4 or higher. +* libzmq - libzmq3-dev or libzmq5-dev. + +#### Toolchain Dependencies + +* C++11 compliant compiler. +* CMake 3.0 or greater is required to perform the build. + +### Build + +Instructions on building the project. + +CMake example: + +```bash +cd SimulatedEbsTm +mkdir -p build/<os> +cd build/<os> +cmake ../.. +make +```