Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jdarge authored Aug 13, 2023
1 parent b25aeeb commit 121a77d
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@
## Commands

```console
$ ./run [build/make]
$ ./run rebuild
$ ./run clean
$ ./run
$ ./run.sh [build/make]
$ ./run.sh rebuild
$ ./run.sh clean
$ ./run.sh
```

Make sure to set the <ins>run</ins> file to be executable.

```console
$ chmod +x run
$ chmod +x run.sh
```

### ./run make/build :
Expand All @@ -45,24 +45,24 @@ Both do the same thing.
<br>They run CMakeList.txt and then the Makefile generated by CMake.

```console
$ ./run make
$ ./run build
$ ./run.sh make
$ ./run.sh build
```

### ./run rebuild :

Deletes previously generated files and then runs CMake and Make

```console
$ ./run rebuild
$ ./run.sh rebuild
```

### ./run clean :

Removes the <ins>build/</ins> directory.

```console
$ ./run clean
$ ./run.sh clean
```

### ./run :
Expand All @@ -71,5 +71,12 @@ If there is binary executable inside of <ins>build/bin</ins> it will run it.
<br>If there isn't, it will run the build commands for you...

```console
$ ./run
$ ./run.sh
```

### Chaining ./run :

Generally while modifying the source code, you should rebuild the project and rerun the executable file.
```
$ ./run.sh rebuild; ./run.sh
```

0 comments on commit 121a77d

Please sign in to comment.