Added documentation

Author: liuzicheng1987

README.md

@@ -554,7 +554,7 @@ https://conan.io/center/recipes/reflect-cpp
 This will compile reflect-cpp with JSON support only. You can then include reflect-cpp in your project and link to the binary.
 
 ```bash
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Release
 cmake --build build -j 4  # gcc, clang
 cmake --build build --config Release -j 4  # MSVC
 ```

benchmarks/README.md

@@ -19,7 +19,7 @@ this repository to learn how to install vcpkg.
 To compile the benchmarks, do the following:
 
 ```bash
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DREFLECTCPP_BUILD_BENCHMARKS=ON
+cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Release -DREFLECTCPP_BUILD_BENCHMARKS=ON
 cmake --build build -j 4 # gcc, clang
 cmake --build build --config Release -j 4 # MSVC
 ```

docs/install.md

@@ -41,7 +41,7 @@ Simply use [this recipe](https://conan.io/center/recipes/reflect-cpp).
 This will compile reflect-cpp with JSON support only. You can then include reflect-cpp in your project and link to the binary.
 
 ```bash
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Release
 cmake --build build -j 4  # gcc, clang
 cmake --build build --config Release -j 4  # MSVC
 ```
@@ -66,6 +66,14 @@ git submodule update --init
 # You may be prompted to install additional dependencies.
 ```
 
+To compile the library:
+
+```bash
+cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DREFLECTCPP_AVRO=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CAPNPROTO=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_MSGPACK=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_TOML=ON -DREFLECTCPP_UBJSON=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
+cmake --build build -j 4 # gcc, clang
+cmake --build build --config Release -j 4 # MSVC
+```
+
 To use reflect-cpp in your project:
 
 ```cmake
@@ -84,6 +92,7 @@ set(REFLECTCPP_YAML ON) # Optional
 target_link_libraries(your_project PRIVATE reflectcpp) # Link against the library
 ```
 
+
 ### Troubleshooting vcpkg
 
 vcpkg is a great, but very ambitious and complex project (just like C++ is a great, but very ambitious and complex language). Here are some of the you might run into and how to resolve them:

docs/result.md

@@ -32,6 +32,9 @@ in C++-23. However, reflect-cpp is a library for C++-20 and until that changes,
 If you do not care about these objections to exceptions, you can just call `rfl::json::read<...>(json_string).value()`,
 which throws an exception, if the result type contains an error and be done with it.
 
+**Note**: If you want to use `std::expected` instead of our own Result type, you can pass `-DREFLECTCPP_USE_STD_EXPECTED` during compilation.
+This requires C++-23 support and may not be supported on all C++ compilers.
+
 ## What is `rfl::Result`?
 
 `rfl::Result` is similar to `std::optional` it that it contains an object that may or may not be there. However,
@@ -134,20 +137,18 @@ if (my_result) {
 
 `rfl::error("error message")` is a simple utility function for `rfl::Unexpected<Error>(Error("error message"))`.
 
-## `.and_other(...)`, `.or_else(...)`, `.or_other(...)`
-
-`r1.and_other(r2)` expects an `r2` or type `rfl::Result<U>`. It returns an error, if `r1` contains an error and `r2` otherwise.
+## `.or_else(...)`, `.transform_error(...)`
 
 `r.or_else(f)` expects a function `f` for type `Error -> rfl::Result<T>`. It returns `r` if `r` did not contain an error and the results of `f` otherwise.
 
+`r.transform_error(f)` expects a function `f` for type `Error -> Error`. 
+
 This is often used to produce better error messages:
 
 ```cpp
 const auto embellish_error = [&](const Error& _e) -> rfl::Result<T> {
     return rfl::error("Failed to parse field '" + key + "': " + _e.what());
 };
-return Parser<T>::read(_r, &_var).or_else(embellish_error);
+return Parser<T>::read(_r, &_var).transform_error(embellish_error);
 ```
 
-`r1.or_other(r2)` expects an `r2` or type `rfl::Result<T>`. It returns an `r1`, if `r1` does not contain an error and `r2` otherwise.
-

tests/README.md

@@ -16,7 +16,7 @@ git submodule update --init
 To compile the tests, do the following:
 
 ```bash
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DREFLECTCPP_BUILD_TESTS=ON
+cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Release -DREFLECTCPP_BUILD_TESTS=ON
 cmake --build build -j 4 # gcc, clang
 cmake --build build --config Release -j 4 # MSVC
 ```
@@ -32,7 +32,7 @@ To run the tests, do the following:
 To compile the tests with serialization formats other than JSON, do the following:
 
 ```bash
-cmake -S . -B build -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_AVRO=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CAPNPROTO=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_MSGPACK=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_TOML=ON -DREFLECTCPP_UBJSON=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
+cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DREFLECTCPP_BUILD_TESTS=ON -DREFLECTCPP_AVRO=ON -DREFLECTCPP_BSON=ON -DREFLECTCPP_CAPNPROTO=ON -DREFLECTCPP_CBOR=ON -DREFLECTCPP_FLEXBUFFERS=ON -DREFLECTCPP_MSGPACK=ON -DREFLECTCPP_XML=ON -DREFLECTCPP_TOML=ON -DREFLECTCPP_UBJSON=ON -DREFLECTCPP_YAML=ON -DCMAKE_BUILD_TYPE=Release
 cmake --build build -j 4 # gcc, clang
 cmake --build build --config Release -j 4 # MSVC
 ```