Remove initial compile instruction and use script typesetting when referring to directories inline

This commit is contained in:
Janita Willumsen 2023-09-25 13:34:01 +02:00
parent 16bcbc3ecc
commit 11cd6aa27e

View File

@ -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.