From a073dc15200c821923055ff809778c8d83ca9d1e Mon Sep 17 00:00:00 2001
From: Sylvain Tricot <sylvain.tricot@univ-rennes1.fr>
Date: Mon, 7 Mar 2022 16:26:19 +0100
Subject: [PATCH] Added INSTALL instructions.

---
 INSTALL.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..46bc1db
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,45 @@
+Building MsSpec_DFM
+===================
+
+To build MsSpec_DFM, you need a fortran compiler (gfortran), python > 3.6 and pip
+
+Getting the source code
+-----------------------
+
+To download the source code, you can clone the git repo of the project
+
+```
+$ git clone https://git.ipr.univ-rennes1.fr/epsi/MsSpec-DFM.git
+```
+
+If git is not avilable on your system, you can download a compressed archive
+on the [repo website](https://git.ipr.univ-rennes1.fr/epsi/MsSpec-DFM).
+Once downloaded, this archive should be uncompressed.
+
+
+Building and installing
+-----------------------
+
+```
+# Change to the src folder
+$ cd MsSpec-DFM/src
+
+# Type in 'make' or 'make all'
+$ make
+
+# This will install the commandline utility and python bindings
+$ make install
+```
+
+Every new Python packages and dependencies will be installed in the
+Python user site packages (under $HOME/.local/ tree).
+
+You can also use a Python virtual environment
+
+
+Uninstalling
+------------
+
+```
+$ pip uninstall msspec_dfm
+```