From ac2944ccae74e0685d62547449dc4fafb99178b5 Mon Sep 17 00:00:00 2001
From: Janita Willumsen <j.willu@me.com>
Date: Thu, 14 Sep 2023 10:20:26 +0200
Subject: [PATCH] Set up basic readme for repo

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3b5f497..95ac081 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,30 @@
-# Project-2
\ No newline at end of file
+# Project 2
+
+## Practical information
+
+- [Project](https://anderkve.github.io/FYS3150/book/projects/project2.html)
+
+## Compile and run
+
+Compiling and linking is done using Make, make sure you are in the root folder. To create executable files, run shell commands 
+
+```shell
+cd src/
+make
+```
+To run `script-name` 
+
+```shell
+./main
+```
+
+
+## Generate plots
+
+To generate plots, the Python scripts is run using
+
+```shell
+python3 <script-name>
+```
+
+The plots will be saved inside [latex/images](../blob/main/latex/images).