Skip to content

Commit 5f22ce2

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

1 file changed

Lines changed: 21 additions & 10 deletions

File tree

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,35 +87,46 @@ We are assuming that you are running Linux or macOS. We recommend that Windows u
8787

8888
Follow the following two steps:
8989

90-
1. 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.
91-
2. Navigate to our repository `experimental_json_builder` and run `./run_docker.sh bash`, 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.
90+
1. Clone the project
9291

92+
```bash
93+
git clone https://github.com/simdjson/experimental_json_builder.git
94+
```
9395

94-
Now you should be able to run the following commands (on the `experimental_json_builder/src`):
96+
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.
97+
98+
3. Navigate to our repository `experimental_json_builder` and run
9599

96-
1. Firstly, configure the build system with cmake:
100+
```bash
101+
./run_docker.sh bash`
102+
```
103+
104+
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.
105+
106+
107+
4. Configure the build system with cmake:
97108
```bash
98109
cmake -B build
99110
```
100111
This only needs to be done once.
101112

102-
2. Build the code...
113+
5. Build the code...
103114
```bash
104115
cmake --build build
105116
```
106117

107-
3. Run the executable.
118+
119+
6. Run the tests...
108120
```bash
109-
./build/src/ExperimentalJsonBuilder
121+
ctest --test-dir build --output-on-failure
110122
```
111123

112-
113-
4. Run the benchmark.
124+
7. Run the benchmark.
114125
```bash
115126
./build/benchmarks/src/SerializationBenchmark
116127
```
117128

118-
You can modify the source code with your favorite editor and run again steps 2 (Build the code) and 3 (Run the executable) and 4 (Run the benchmark).
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).
119130

120131
## Instructions for running it natively on macOS
121132

0 commit comments

Comments
 (0)