Stuff

README.md

@@ -1,9 +1,13 @@
 # Simulating the Schrödinger wave equation using the Crank-Nicolson method in 2+1 dimensions
 
-[Repo](https://github.uio.no/FYS3150-G2-2023/Project-5)
+[Gitea repo](https://gitea.balaton.dev/FYS3150/Project-5)
+
+[GitHub repo](https://github.uio.no/FYS3150-G2-2023/Project-5)
 
 [Documentation](https://pages.github.uio.no/FYS3150-G2-2023/Project-5/)
 
+![Double slit animation](./images/animation.gif)
+
 ## Requirements
 
 ### Operating systems
@@ -60,12 +64,16 @@ To run any of the programs, just use the following command:
     ./<bin|debug>/<program-name> <args>
 ```
 
-If you need help with any of the programs, you can use the **-h** or **--help**
-flag to show you how to use the programs. Here is an example:
+For the **wave_simulation** program, you can use a file where each line contains
+a configuration for the WaveSimulation class and what to output to a file.
+This different values should be separated by semicolons. 
+Here is the order of what variables should be in one line:
 
-```shell
-    ./bin/main --help
-```
+    h; dt; T; x_c; y_c; sigma_x; sigma_y; p_x; p_y; <thickness; pos_x; ap_sep; ap; slits>; <write_each step || the steps to write to file>
+
+where <> is optional.
+
+An example of a file can be found under the args directory.
 
 ### Python scripts