From ef96e63fa394cbba77cafe43c348cd7f9f2794eb Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Mon, 11 Dec 2023 14:59:33 +0100
Subject: [PATCH] Fix formatting of README files
---
src/README.md | 6 +++---
src/scripts/README.md | 7 ++++---
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/src/README.md b/src/README.md
index d232a0eb..34b34c1d 100644
--- a/src/README.md
+++ b/src/README.md
@@ -17,14 +17,14 @@ In all cases, build commands executed through `make` will output the object file
3. cd to the `build/sphere` folder.
4. Run `sph` following the instructions given in `build\README.md`
-3. cd to the `build/cluster` folder.
-4. Run `clu` following the instructions given in `build\README.md`
+5. cd to the `build/cluster` folder.
+6. Run `clu` following the instructions given in `build\README.md`
## C++ code setup and execution (requires `g++` and GNU `make`)
1. Follow the FORTRAN code setup steps (this builds the C++ version too).
2. cd to the `build/sphere` folder.
-3. run `np_sphere`:
+3. Run `np_sphere`:
> ./np_sphere
diff --git a/src/scripts/README.md b/src/scripts/README.md
index e0296f58..b3babd3e 100644
--- a/src/scripts/README.md
+++ b/src/scripts/README.md
@@ -14,9 +14,10 @@ The code migration stage can be considered successfully fulfilled with the solut
> $PATH_TO_SCRIPT/pycompare.py --ffile=FORTRAN_OUTPUT --cfile=C++_OUTPUT
(The above assumes that `PATH_TO_SCRIPT` is a variable that expands to the path were the script is located). The required output files are called by default `OSPH` and `OCLU` by FORTRAN and `c_OSPH` and `c_OCLU` by C++, depending on whether the sphere or the cluster case was executed.
-4. Check the output of the script to verify that it detects 0 errors and finishes in a `SUCCESS` state.
-5. In case of need, add the `--html` argument to produce an *HTML* log showing the possible differences and a classification of their severity.
-6. Issuing:
+
+3. Check the output of the script to verify that it detects 0 errors and finishes in a `SUCCESS` state.
+4. In case of need, add the `--html` argument to produce an *HTML* log showing the possible differences and a classification of their severity.
+5. Issuing:
> $PATH_TO_SCRIPT/pycompare.py --help
--
GitLab