From d95f5f41557b77a623c54594a25c60d7cf4643be Mon Sep 17 00:00:00 2001
From: mer0m <baptiste.marechal@femto-st.fr>
Date: Mon, 23 Jan 2017 11:10:31 +0100
Subject: [PATCH] add readme

---
 README    |  0
 README.md | 19 +++++++++++++++++++
 2 files changed, 19 insertions(+)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index e69de29..0000000
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4966324
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+sicav_sim
+===========
+python-sympy -based scripts for photonics symbolic calculations
+
+Dependencies
+------------
+- python-sympy 'sudo apt install python-sympy'
+
+Test it
+----------
+run in iPython environment to show local variables
+
+```sh
+ipython
+```
+
+```ipython
+run %script
+```
-- 
2.16.4