From 53900b120578d647c166797db2bfa3abe20b7519 Mon Sep 17 00:00:00 2001 From: Cory Date: Tue, 5 Dec 2023 19:32:32 +0100 Subject: [PATCH] Update README --- Doxyfile | 2 +- README.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Doxyfile b/Doxyfile index 8428bbb..3f830cd 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1237,7 +1237,7 @@ VERBATIM_HEADERS = YES # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. -CLANG_ASSISTED_PARSING = YES +CLANG_ASSISTED_PARSING = NO # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS # tag is set to YES then doxygen will add the directory of each input to the diff --git a/README.md b/README.md index 2b70efa..24860c5 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Compiling regular binaries is as easy as running this command: make ``` -The binaries will then be inside the **./bin** directory. +The binaries will then be inside the **bin** directory. ### Profiling binaries @@ -55,7 +55,7 @@ If you want to profile the programs (specifically the MPI program), then run thi make profile ``` -The binaries will then be inside the **./prof** directory. +The binaries will then be inside the **prof** directory. ### Debugging binaries @@ -65,7 +65,7 @@ If you want to debug the code, then use this command: make debug ``` -The binaries will then be inside the **./debug** directory. +The binaries will then be inside the **debug** directory. ## Running programs @@ -113,10 +113,10 @@ If you have any problems running the scripts, you might have to run this instead ### Batch system -For the **phase_transition_mpi** program, there are scripts in the **./slurm_scripts** +For the **phase_transition_mpi** program, there are scripts in the **slurm_scripts** directory that come along with it. This is to be able to run it on a batch system using Slurm if you have access to one. -The only program that should be executed by the user is the **./slurm_scripts/execute.script** +The only program that should be executed by the user is the **slurm_scripts/execute.script** script. You can see how to use this script by doing: ```shell @@ -139,7 +139,7 @@ this repo on that system, then compile the MPI program like this: make bin/phase_transition_mpi ``` -After compiling, you can schedule it by using the **./slurm_scripts/execute.script**: +After compiling, you can schedule it by using the **slurm_scripts/execute.script**: ```shell ./slurm_scripts/execute.script