Remove initial compile instruction and use script typesetting when referring to directories inline
This commit is contained in:
parent
16bcbc3ecc
commit
11cd6aa27e
32
README.md
32
README.md
@ -6,39 +6,27 @@
|
|||||||
|
|
||||||
## Compile and run C++ programs
|
## 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
|
There are two ways of compiling the code. The first alternative is to change
|
||||||
cd src/
|
directory to `src/` and compile
|
||||||
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
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
cd src && make
|
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
|
```shell
|
||||||
make code
|
make code
|
||||||
```
|
```
|
||||||
|
|
||||||
and it will compile everything with you needing to move into **src**.
|
You can run any of the compiled programs by changing directory to `src/`, then
|
||||||
|
|
||||||
You can run any of the compiled programs by going into the src directory
|
|
||||||
and then doing
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
./program-name
|
./test_suite
|
||||||
|
./main
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -64,7 +52,7 @@ If you want to generate the documentation you can do
|
|||||||
make docs
|
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.
|
directory.
|
||||||
|
|
||||||
## Generate project document
|
## Generate project document
|
||||||
@ -75,4 +63,4 @@ If you want to recompile the Pdf file, you can do
|
|||||||
make latex
|
make latex
|
||||||
```
|
```
|
||||||
|
|
||||||
and a Pdf file will be produced inside the **latex** directory.
|
and a Pdf file will be produced inside the `latex/` directory.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user