diff --git a/.gitignore b/.gitignore index 175443b7..0ec725da 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,3 @@ -visual_studio - -/benchbranch/ -/submodules/ - # eclipse project files .cproject .project @@ -52,117 +47,6 @@ gens libs objs -# Build outputs (TODO build to a subdir so we can exclude that instead) -/.simdjson-user-CMakeCache.txt -/allparserscheckfile -/allparsingcompetition -/basictests -/benchfeatures -/benchmark/allparsingcompetition -/benchmark/bench_dom_api -/benchmark/bench_parse_call -/benchmark/distinctuseridcompetition -/benchmark/get_corpus_benchmark -/benchmark/minifiercompetition -/benchmark/parse -/benchmark/parseandstatcompetition -/benchmark/parse_nonumberparsing -/benchmark/parse_nostringparsing -/benchmark/parse_noutf8validation -/benchmark/parse_stream -/benchmark/parsingcompetition -/benchmark/perfdiff -/benchmark/simdjson-master -/benchmark/statisticalmodel -/build/ -/build-ossfuzz-*/ -/build-plain-*/ -/corpus.zip -/distinctuseridcompetition -/errortests -/examples/quickstart/quickstart -/examples/quickstart/quickstart11 -/examples/quickstart/quickstart14 -/examples/quickstart/quickstart17 -/examples/quickstart/simdjson.cpp -/examples/quickstart/simdjson.h -/examples/quickstart/twitter.json -/fuzz/fuzz_dump -/fuzz/fuzz_dump_raw_tape -/fuzz/fuzz_minify -/fuzz/fuzz_parser -/fuzz/fuzz_print_json -/get_corpus_benchmark -/json2json -/jsoncheck -/jsoncheck_westmere -/jsoncheck_fallback -/jsonpointer -/jsonstats -/integer_tests -/libsimdjson.so* -/minifiercompetition -/minify -/numberparsingcheck -/ossfuzz-out -/out -/parse -/parse_many_test -/parse_nonumberparsing -/parse_nostringparsing -/parse_noutf8validation -/parse_stream -/parseandstatcompetition -/parsingcompetition -/perfdiff -/pointercheck -/readme_examples -/readme_examples11 -/readme_examples_noexceptions -/readme_examples_noexceptions11 -/staticchecks -/statisticalmodel -/stringparsingcheck -/submodules -/ujdecode.o -/amalgamate_demo.cpp -/simdjson.cpp -/simdjson.h -/singleheader/amalgamate_demo -/singleheader/demo -/tests/allparserscheckfile -/tests/basictests -/tests/checkimplementation -/tests/compilation_failure_tests/dangling_parser_load_should_compile -/tests/compilation_failure_tests/dangling_parser_parse_padstring_should_compile -/tests/compilation_failure_tests/dangling_parser_parse_stdstring_should_compile -/tests/compilation_failure_tests/dangling_parser_parse_uchar_should_compile -/tests/compilation_failure_tests/dangling_parser_parse_uint8_should_compile -/tests/compilation_failure_tests/example_compiletest_should_compile -/tests/errortests -/tests/extracting_values_example -/tests/integer_tests -/tests/jsoncheck -/tests/numberparsingcheck -/tests/pointercheck -/tests/parse_many_test -/tests/readme_examples -/tests/readme_examples11 -/tests/readme_examples_noexceptions -/tests/readme_examples_noexceptions11 -/tests/staticchecks -/tests/stringparsingcheck -/tools/json2json -/tools/jsonstats -/tools/minify -/build*/ - -# Don't check in generated API docs -/doc/api - -# Don't check in generated examples -/jsonexamples/generated - # C++ ignore from https://github.com/github/gitignore/blob/master/C%2B%2B.gitignore # Prerequisites @@ -199,27 +83,19 @@ objs *.app -### https://raw.github.com/github/gitignore/e92f8db7a027af8cc25da2dc0758317e39697684/CMake.gitignore - -CMakeLists.txt.user -CMakeCache.txt -CMakeFiles -CMakeScripts -Testing -Makefile -cmake_install.cmake -install_manifest.txt -compile_commands.json -CTestTestfile.cmake -_deps - # CMake files that may be specific to our installation -/CPackConfig.cmake -/CPackSourceConfig.cmake -# We check in a custom version of root Makefile that is not generated by CMake -!/Makefile -singleheader/amalgamation_demo -singleheader/amalgamation_demo.cpp -singleheader/simdjson.cpp -singleheader/simdjson.h \ No newline at end of file +# Build outputs +/build*/ + +# Fuzzer outputs generated by instructions in fuzz/Fuzzing.md +/corpus.zip +/ossfuzz-out/ +/out/ + +# Don't check in generated API docs +/doc/api + +# Don't check in generated examples +/jsonexamples/generated +/visual_studio diff --git a/HACKING.md b/HACKING.md index d0af7473..7627029f 100644 --- a/HACKING.md +++ b/HACKING.md @@ -199,9 +199,9 @@ We assume you have a common 64-bit Windows PC with at least Visual Studio 2017 a - Grab the simdjson code from GitHub, e.g., by cloning it using [GitHub Desktop](https://desktop.github.com/). - Install [CMake](https://cmake.org/download/). When you install it, make sure to ask that `cmake` be made available from the command line. Please choose a recent version of cmake. -- Create a subdirectory within simdjson, such as `VisualStudio`. +- Create a subdirectory within simdjson, such as `build`. - Using a shell, go to this newly created directory. You can start a shell directly from GitHub Desktop (Repository > Open in Command Prompt). -- Type `cmake -DCMAKE_GENERATOR_PLATFORM=x64 ..` in the shell while in the `VisualStudio` repository. (Alternatively, if you want to build a DLL, you may use the command line `cmake -DCMAKE_GENERATOR_PLATFORM=x64 -DSIMDJSON_BUILD_STATIC=OFF ..`.) +- Type `cmake -DCMAKE_GENERATOR_PLATFORM=x64 ..` in the shell while in the `build` repository. (Alternatively, if you want to build a DLL, you may use the command line `cmake -DCMAKE_GENERATOR_PLATFORM=x64 -DSIMDJSON_BUILD_STATIC=OFF ..`.) - This last command (`cmake ...`) created a Visual Studio solution file in the newly created directory (e.g., `simdjson.sln`). Open this file in Visual Studio. You should now be able to build the project and run the tests. For example, in the `Solution Explorer` window (available from the `View` menu), right-click `ALL_BUILD` and select `Build`. To test the code, still in the `Solution Explorer` window, select `RUN_TESTS` and select `Build`.