Skip to content

Commit 4d95283

Browse files
committed
Modify the source README.mdpp
1 parent 20f2ff8 commit 4d95283

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,4 @@ cmake -G Ninja .. -DCPPPARSER_BUILD_TESTS=ON
138138
ninja && ninja test
139139
```
140140

141-
Modify the command if you prefer `make`.
141+
Modify the command by removing `-G Ninja` if you prefer `make`.

cppparser/src/README.mdpp

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ For AST traversing, see the [CppWriter](cppwriter), that uses the generated AST
4141
### Get the source
4242

4343
```sh
44-
git clone https://github.com/satya-das/common.git
4544
git clone https://github.com/satya-das/CppParser.git
4645
```
4746

@@ -52,7 +51,7 @@ cd cppparser
5251
mkdir builds
5352
cd builds
5453
cmake ..
55-
make && make test
54+
make
5655
```
5756

5857
*Alternatively, if you prefer `Ninja` instead of `make`*:
@@ -62,6 +61,27 @@ cd cppparser
6261
mkdir builds
6362
cd builds
6463
cmake -G Ninja ..
64+
ninja
65+
```
66+
67+
## For contributors who need to run tests
68+
69+
Make sure you also clone the dependencies. Run the following command in the parent directory of root of the `cppparser`.
70+
71+
```sh
72+
git clone https://github.com/satya-das/common.git
73+
```
74+
75+
After this command the `common` and `cppparser` should be in the same folder.
76+
77+
## Configure and run test
78+
79+
```sh
80+
cd cppparser
81+
mkdir builds
82+
cd builds
83+
cmake -G Ninja .. -DCPPPARSER_BUILD_TESTS=ON
6584
ninja && ninja test
6685
```
6786

87+
Modify the command by removing `-G Ninja` if you prefer `make`.

0 commit comments

Comments
 (0)