From 4257d8f3ef7169cc92b8a39cbd748e59ecbc4af6 Mon Sep 17 00:00:00 2001
From: Samo Penic <samo.penic@fe.uni-lj.si>
Date: Tue, 06 Oct 2015 11:22:40 +0000
Subject: [PATCH] Changed README file to explain the installation procedure.

---
 README |   46 +++++++++++++++++++++++++++++++++++++++++++---
 1 files changed, 43 insertions(+), 3 deletions(-)

diff --git a/README b/README
index cb3d035..788c0df 100644
--- a/README
+++ b/README
@@ -1,3 +1,43 @@
-This will be a README file
-This is a second line of README, important enough to commit immediately.
-Another line
+TRISURF NG
+==========
+
+
+1. Instalation
+--------------
+
+To compile the program, user must have ``automake'', and ``gcc'' tools installed on the computer.
+
+Required libraries are:
+* libconfuse
+* libgsl
+* libxml2
+
+On Debian based systems, install prerequisities by typing the following command in the command line:
+
+``sudo apt-get install libconfuse-dev libgsl0-dev libxml2-dev automake gcc''
+
+Move to the project root directory and compile with:
+
+``./configure''
+``make''
+``make install''
+
+If you are experiencing difficulties due to different automake versions, proceed with the longer procedure:
+
+``aclocal''
+``autoheader''
+``automake -ac''
+``autoconf''
+``./configure''
+``make''
+``make install''
+
+
+2. Use
+------
+
+Prepare tape file, storing the definition for the simulation. You can use the sample tape file in the ``src/'' directory as a template for your simulation.
+
+Run simulations with ``trisurf-ng --force-from-tape'' for initial run, or ``trisurf-ng'' for continuing aborted simulations.
+
+

--
Gitblit v1.9.3