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 +``` + +The plots will be saved inside [latex/images](../blob/main/latex/images).