Skip to content

Commit 36b1c55

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

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,18 @@ git clone https://github.com/simdjson/experimental_json_builder.git
9595

9696
2. Make sure that you have [docker installed and running](https://docs.docker.com/engine/install/) on your system. Most Linux distributions support docker though some (like RedHat) have the equivalent (Podman). Users of Apple systems may want to [consider OrbStack](https://orbstack.dev). You do not need to familiar with docker, you just need to make sure that you are have it running.
9797

98-
3. Navigate to our repository `experimental_json_builder` and run
98+
3. Navigate to our repository `experimental_json_builder` and run the following bash script:
9999

100100
```bash
101-
./run_docker.sh bash`
101+
bash run_docker.sh bash
102102
```
103103

104+
105+
104106
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.
105107

108+
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.
109+
106110

107111
4. Configure the build system with cmake:
108112
```bash
@@ -126,7 +130,7 @@ ctest --test-dir build --output-on-failure
126130
./build/benchmarks/src/SerializationBenchmark
127131
```
128132

129-
You can modify the source code with your favorite editor and run again steps 5 (Build the code) and 6 (Run the tests) and 7 (Run the benchmark).
133+
You can modify the source code with your favorite editor and run again steps 6 (Build the code) and 7 (Run the tests) and 8 (Run the benchmark).
130134

131135
## Instructions for running it natively on macOS
132136

0 commit comments

Comments
 (0)