Merge pull request #28 from LLNL/sbromberger/cmake-readme-and-license

Sbromberger/cmake readme and license

Author: sbromberger

.github/workflows/ci.yaml

@@ -17,8 +17,8 @@ jobs:
         working-directory: cpp
         run: |
           cmake --preset=default
-          cd build && make
+          cd build/release && make
 
       - name: Test JL code
-        working-directory: cpp/build
+        working-directory: cpp/build/release
         run: make test

.gitignore

@@ -1,15 +1,13 @@
-.vscode-old/
 .DS_Store
 CMakeFiles/
-build/
+**/build/
 .cache/
 CMakeCache.txt
 Makefile
 *.cmake
 *.so
 testeval.bin
 __pycache__
-**/build*
 venv
 *.core
 setup.cfg

cpp/.vscode/launch.json

@@ -5,7 +5,7 @@
             "name": "Debug Benchmark",
             "type": "cppdbg",
             "request": "launch",
-            "program": "${workspaceFolder}/build-debug/bench/${input:benchmarkExecutable}",
+            "program": "${workspaceFolder}/build/debug/bench/${input:benchmarkExecutable}",
             "args": [],
             "stopAtEntry": false,
             "cwd": "${workspaceFolder}",

cpp/.vscode/settings.json

@@ -4,13 +4,13 @@
 
     // CMake configuration for this project
     "cmake.generator": "Unix Makefiles",
-    "cmake.buildDirectory": "${workspaceFolder}/build",
+    "cmake.buildDirectory": "${workspaceFolder}/build/release",
 
     // Clangd configuration specific to this project
     "clangd.arguments": [
         "-j=4",
         "--background-index",
-        "--compile-commands-dir=${workspaceFolder}/build",
+        "--compile-commands-dir=${workspaceFolder}",
         "--clang-tidy",
         "--completion-style=detailed",
         "--header-insertion=iwyu",
@@ -23,14 +23,12 @@
 
     // Project-specific search exclusions
     "search.exclude": {
-        "**/build/**": true,
-        "**/build-*/**": true
+        "**/build/**": true
     },
 
     // Project-specific file watcher exclusions
     "files.watcherExclude": {
-        "**/build/**": true,
-        "**/build-*/**": true
+        "**/build/**": true
     },
 
     // Project-specific spell checker words

cpp/CMakePresets.json

@@ -12,7 +12,7 @@
         "JSONLOGIC_ENABLE_TESTS": "ON"
       },
       "generator": "Unix Makefiles",
-      "binaryDir": "${sourceDir}/build"
+      "binaryDir": "${sourceDir}/build/release"
     },
     {
       "name": "debug",
@@ -25,7 +25,7 @@
         "JSONLOGIC_ENABLE_TESTS": "ON"
       },
       "generator": "Unix Makefiles",
-      "binaryDir": "${sourceDir}/build-debug"
+      "binaryDir": "${sourceDir}/build/debug"
     },
 
     {
@@ -39,7 +39,7 @@
         "JSONLOGIC_ENABLE_TESTS": "ON"
       },
       "generator": "Unix Makefiles",
-      "binaryDir": "${sourceDir}/build-relwithdebinfo"
+      "binaryDir": "${sourceDir}/build/relwithdebinfo"
     }
   ],
   "buildPresets": [

cpp/README.md

@@ -1,37 +1,34 @@
 # JsonLogic for C++
 
-This is an implementation for [JsonLogic](https://jsonlogic.com/) for C++. The API uses the Boost
-JSON implementation (e.g.,
+This is an implementation for [JsonLogic](https://jsonlogic.com/) for C++. The API uses the Boost JSON implementation (e.g.,
 [Boost 1.82](https://www.boost.org/doc/libs/1_82_0/libs/json/doc/html/index.html)).
 
-The library is designed to follow the type conversion rules of the reference JsonLogic
-implementation.
+The library is designed to follow the type conversion rules of the reference JsonLogic implementation.
 
 ## Compile and Install
 
-The library can be installed using cmake.
-
-    mkdir build
-    cd build
-    cmake ..
+The library can be installed using cmake. From the top-level directory,
+    cmake --preset=default
+    cd build/release
     make
 
 ## Use
 
 The simplest way is to create Json rule and data options and call jsonlogic::apply.
-
+```cpp
     #include <jsonlogic/logic.hpp>
 
     boost::json::value rule = ..;
     boost::json::value data = ..;
     jsonlogic::any_expr res = jsonlogic::apply(rule, data);
     std::cout << res << std::endl;
+```
 
-See examples/testeval.cc for the complete sample code.
+See `examples/testeval.cc` for the complete sample code.
 
-To evaluate a rule multiple times, it may be beneficial to convert the Json object into JsonLogic's
-internal expression representation.
+To evaluate a rule multiple times, it may be beneficial to convert the Json object into JsonLogic's internal expression representation.
 
+```cpp
     #include <jsonlogic/logic.hpp>
 
     boost::json::value rule = ..;
@@ -44,6 +41,7 @@ internal expression representation.
 
         std::cout << jsonlogic.apply(logic.syntax_tree(), std::move(varlookup)) << std::endl;
     }
+```
 
 ## Python Companion
 
@@ -53,10 +51,11 @@ that can be evaluated by JsonLogic.
 ## Authors
 
 Peter Pirkelbauer (pirkelbauer2 at llnl dot gov)
+Seth Bromberger (seth at llnl dot gov)
 
 ## License
 
-CLIPPy is distributed under the MIT license.
+JsonLogic is distributed under the MIT license.
 
 See LICENSE-MIT, NOTICE, and COPYRIGHT for details.
 

cpp/compile_commands.json

@@ -18,11 +18,11 @@ function run {
 
 # test using apply(rule, variant_vector) 
 #      with apply(rule, data) as fallback
-TESTBIN="../build/tests/testeval"
+TESTBIN="./tests/testeval"
 run
 
 # test using always apply(rule, data)
-TESTBIN="../build/tests/testeval -s"
+TESTBIN="./tests/testeval -s"
 run
 
 echo "All tests passed."