From 25e1420e443394c37a00166ea2c87600151113ff Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Fri, 11 Aug 2023 10:27:26 -0400 Subject: [PATCH] Add/update per-library READMEs --- SabreTools.Models/README.MD | 2 +- SabreTools.Serialization/README.MD | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 SabreTools.Serialization/README.MD diff --git a/SabreTools.Models/README.MD b/SabreTools.Models/README.MD index 3192a663..5afae30a 100644 --- a/SabreTools.Models/README.MD +++ b/SabreTools.Models/README.MD @@ -1,6 +1,6 @@ # SabreTools.Models -This library comprises of models that represent either directly serializable or representative structures for all DAT types. This library is currently unused by any other library in SabreTools, as there are no ways of properly dealing with conversion between models, filtering, or many of the other features. All of the main models representing metadata files should have parsers created outside of the current code. The parser code will likely be partially patterned off of the code being used to create the serialization tests. +This library comprises of models that represent either directly serializable or representative structures for all DAT types. All of the main models representing metadata files should have parsers created outside of the current code. The parser code will likely be partially patterned off of the code being used to create the serialization tests. In each completed model, there is a section that looks like the following: ``` diff --git a/SabreTools.Serialization/README.MD b/SabreTools.Serialization/README.MD new file mode 100644 index 00000000..80a0bf8f --- /dev/null +++ b/SabreTools.Serialization/README.MD @@ -0,0 +1,3 @@ +# SabreTools.Serialization + +This library comprises of serializers that both read and write from files and streams to the dedicated models as well as convert to and from the common internal models. This library is partially used by the current parsing and writing code but none of the internal model serialization is used. \ No newline at end of file