From a22c09ff0f1a58be93692bac0de848b4ed25b88c Mon Sep 17 00:00:00 2001
From: Alexis GAMELIN <alexis.gamelin@synchrotron-soleil.fr>
Date: Thu, 20 May 2021 15:46:26 +0000
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0543c4a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+mbtrack2
+========
+
+mbtrack2 is a coherent object-oriented framework written in python to work on collective effects in synchrotrons.
+
+mbtrack2 is composed of different modules allowing to easily write scripts for single bunch or multi-bunch tracking using MPI parallelization in a transparent way. The base of the tracking model of mbtrack2 is inspired by mbtrack, a C multi-bunch tracking code initially developed at SOLEIL.
+
+Installation
+------------
+TODO
+
+References
+----------
+A. Gamelin, W. Foosang, and R. Nagaoka, “mbtrack2, a Collective Effect Library in Python”, presented at the 12th Int. Particle Accelerator Conf. (IPAC'21), Campinas, Brazil, May 2021, paper MOPAB070. 
-- 
GitLab