Skip to content

Commit c202062

Browse files
authored
[no-ci] Update README.md
1 parent 36b1c55 commit c202062

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,31 +101,35 @@ git clone https://github.com/simdjson/experimental_json_builder.git
101101
bash run_docker.sh bash
102102
```
103103

104-
105-
106104
This will enter a bash shell with access to the repo directory. Note that this will take some time when running it for the first time, since the specific container image has to be built.
107105

108106
This step builds and executes a docker container defined by our [Dockerfile](https://github.com/simdjson/experimental_json_builder/blob/main/Dockerfile) which provides the necessary environment.
109107

110108

111-
4. Configure the build system with cmake:
109+
4. The project has some dependencies and you may want to avoid redownloading them. Thus you should set the cache directory:
110+
111+
```bash
112+
export CPM_SOURCE_CACHE=.cache/CPM
113+
```
114+
115+
5. Configure the build system with cmake:
112116
```bash
113117
cmake -B build
114118
```
115119
This only needs to be done once.
116120

117-
5. Build the code...
121+
6. Build the code...
118122
```bash
119123
cmake --build build
120124
```
121125

122126

123-
6. Run the tests...
127+
7. Run the tests...
124128
```bash
125129
ctest --test-dir build --output-on-failure
126130
```
127131

128-
7. Run the benchmark.
132+
8. Run the benchmark.
129133
```bash
130134
./build/benchmarks/src/SerializationBenchmark
131135
```

0 commit comments

Comments
 (0)