From 11cd6aa27ea9a67592597e88af36897a4fc6bf97 Mon Sep 17 00:00:00 2001 From: Janita Willumsen Date: Mon, 25 Sep 2023 13:34:01 +0200 Subject: [PATCH] Remove initial compile instruction and use script typesetting when referring to directories inline --- README.md | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 6d8b69b..052cad3 100644 --- a/README.md +++ b/README.md @@ -6,39 +6,27 @@ ## Compile and run C++ programs -Compiling and linking is done using Make, make sure you are in the root folder. To create executable files, run shell commands +Compiling and linking is done using Make, make sure you are in the root directory. -```shell -cd src/ -make -``` -To run `script-name` - -```shell -./main -``` - -There are two ways of compiling the code. - -The first way is to go into the src directory and compile +There are two ways of compiling the code. The first alternative is to change +directory to `src/` and compile ```shell cd src && make ``` -or you could use make in the project directory +The second alternative does not involve changing directory to `src/`, use +make in the projects root directory ```shell make code ``` -and it will compile everything with you needing to move into **src**. - -You can run any of the compiled programs by going into the src directory -and then doing +You can run any of the compiled programs by changing directory to `src/`, then ```shell - ./program-name + ./test_suite + ./main ``` @@ -64,7 +52,7 @@ If you want to generate the documentation you can do make docs ``` -in the project root, and the documentation will be made into the **docs** +in the project root, and the documentation will be made into the `docs/` directory. ## Generate project document @@ -75,4 +63,4 @@ If you want to recompile the Pdf file, you can do make latex ``` -and a Pdf file will be produced inside the **latex** directory. +and a Pdf file will be produced inside the `latex/` directory.