Set up basic readme for repo
This commit is contained in:
parent
3ecbc9a639
commit
ac2944ccae
31
README.md
31
README.md
@ -1 +1,30 @@
|
||||
# Project-2
|
||||
# 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).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user