Skip to content

Commit d94cd65

Browse files
authored
We used to have a requirements section which went away. I think it is required. (simdjson#749)
1 parent 3c1b403 commit d94cd65

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

doc/basics.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ The Basics
33

44
An overview of what you need to know to use simdjson, with examples.
55

6+
* [Requirements](#requirements)
67
* [Including simdjson](#including-simdjson)
78
* [The Basics: Loading and Parsing JSON Documents](#the-basics-loading-and-parsing-json-documents)
89
* [Using the Parsed JSON](#using-the-parsed-json)
@@ -14,6 +15,13 @@ An overview of what you need to know to use simdjson, with examples.
1415
* [Newline-Delimited JSON (ndjson) and JSON lines](#newline-delimited-json-ndjson-and-json-lines)
1516
* [Thread Safety](#thread-safety)
1617

18+
19+
Requirements
20+
------------------
21+
22+
- A recent compiler (LLVM clang6 or better, GNU GCC 7 or better, Visual Studio 2017 or better). We require C++11 support as a minimum.
23+
- A 64-bit system (ARM or x64 Intel/AMD). Under Visual Studio, you must compile for 64-bit (e.g., x64) targets.
24+
1725
Including simdjson
1826
------------------
1927

@@ -50,7 +58,7 @@ dom::parser parser;
5058
dom::element doc = parser.parse("[1,2,3]"_padded); // parse a string
5159
```
5260

53-
Note: The parsed document resulting from the `parser.load` and `parser.parse` calls depends on the `parser` instance. Thus the `parser` instance must remain in scope. Furthermore, you must have at most one parsed document in play per `parser` instance. Calling `parse` or `load` a second time invalidates the previous parsed document. If you need access simultaneously to several parsed documents, you need to have several `parser` instances.
61+
The parsed document resulting from the `parser.load` and `parser.parse` calls depends on the `parser` instance. Thus the `parser` instance must remain in scope. Furthermore, you must have at most one parsed document in play per `parser` instance. Calling `parse` or `load` a second time invalidates the previous parsed document. If you need access simultaneously to several parsed documents, you need to have several `parser` instances. For best performance, a `parser` instance should be reused.
5462

5563
Using the Parsed JSON
5664
---------------------

0 commit comments

Comments
 (0)