Skip to content

Commit 7ac6e2e

Browse files
authored
minor tweak to readme and docs index
1 parent f94c5fb commit 7ac6e2e

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ cmake --build build -j 4 # gcc, clang
545545
cmake --build build --config Release -j 4 # MSVC
546546
```
547547

548-
***ToDo: ... only if json is enough ...***
548+
If you need support for any other supported [serialization formats](#serialization-formats), refer to the [documentation](https://rfl.getml.com/docs-readme) for installation instructions.
549549

550550
You can also [include the source files](https://rfl.getml.com/install/#option-1-include-source-files-into-your-own-build) into your build or compile it using [cmake and vcpkg.](https://rfl.getml.com/install/#option-3-compilation-using-cmake-and-vcpkg) For detailed installation instructions, please refer to the [install guide](https://rfl.getml.com/install).
551551

docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,16 @@ Reflect-cpp fills an important gap in C++ development. It minimizes boilerplate
4949

5050
Suppose your C++ program has complex data structures it needs to save and load. Or maybe it needs to interact with some kind of external API. If you do this the traditional way, you will have a lot of boilerplate code. This is annoying and error-prone.
5151

52+
!!! example
53+
54+
If you are new to reflect-cpp, please refer to our [GitHub repository](https://github.com/getml/reflect-cpp) for the latest list of supported [serialization formats]. You will also find a [simple] and [more comprehensive code example].
55+
56+
[github repo]: https://github.com/getml/reflect-cpp
57+
[serialization formats]: https://github.com/getml/reflect-cpp#serialization-formats
58+
[simple]: https://github.com/getml/reflect-cpp#simple-example
59+
[more comprehensive code example]: https://github.com/getml/reflect-cpp#more-comprehensive-example
60+
61+
5262
reflect-cpp is not just a reflection library, it is for **serialization, deserialization and validation** through reflection.
5363

5464
That means that you can encode your requirements about the input data in the type system and have them validated upfront. This is why the library also includes algebraic data types like tagged unions and numerous validation routines. Having your requirements encoded in the type system is the most reliable way of ensuring they are met. If your requirements are not met, the user of your software gets a very clear error message. Encoding your requirements in the type system also makes it a lot easier for anyone reading your code.

0 commit comments

Comments
 (0)