From 42ed27ff176a918476d5bad7d8c91d11e720818c Mon Sep 17 00:00:00 2001
From: BENCE Aurelien <aurelien.bence@synchrotron-soleil.fr>
Date: Tue, 12 Dec 2023 10:12:21 +0100
Subject: [PATCH] Add README.md

---
 README.md | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 129 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ed3e7cd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,129 @@
+
+<a name="readme-top"></a>
+<!--
+*** Thanks for checking out the Best-README-Template. If you have a suggestion
+*** that would make this better, please fork the repo and create a pull request
+*** or simply open an issue with the tag "enhancement".
+*** Don't forget to give the project a star!
+*** Thanks again! Now go create something AMAZING! :D
+-->
+
+
+
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  
+
+  <h3 align="center">Kalypso Cam Tango Device</h3>
+
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+
+### Built With
+
+This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
+
+* [![Next][Next.js]][Next-url]
+* [![React][React.js]][React-url]
+* [![Vue][Vue.js]][Vue-url]
+* [![Angular][Angular.io]][Angular-url]
+* [![Svelte][Svelte.dev]][Svelte-url]
+* [![Laravel][Laravel.com]][Laravel-url]
+* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
+* [![JQuery][JQuery.com]][JQuery-url]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+This is an example of how you may give instructions on setting up your project locally.
+To get a local copy up and running follow these simple example steps.
+
+### Prerequisites
+
+You must have installed Tango and PyTango locally on the kalypso PC and have a valid tango environment (TANGO_DB,...).
+* tango
+``` sh
+sudo apt-get update
+sudo apt install tango-starter tango-test liblog4j1.2-java 
+> sudo apt install --assume-yes wget\
+   wget -c https://people.debian.org/~picca/libtango-java_XX_version.deb\
+   sudo dpkg -i ./libtango-java_XX_version.deb
+sudo apt install python3-tango   
+```
+
+you have to declare device in your tango environnement
+with properties correctly set
+https://gitlab.synchrotron-soleil.fr/dg/ds_dg_pytango_package/kalypso_cam/-/wikis/home
+
+### Installation
+
+Just copy project in local folder and start it
+example:
+```sh
+/home/kalypso/device/kalypso_cam/./DG_PY_Kalypso.py <instance_name> -V4
+```
+
+
+
+
+
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the GNUV3 License. See `LICENSE.MD` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
-- 
GitLab