Remove python only use YAML

Author: guuskuiper

README.md

@@ -71,26 +71,16 @@ flowchart TD
   - SyncZeroMQLayer: to connect to the Synchronizer (connection)
 
 ### Store generation
-C# stores can be generated from the `<name>Meta.py`. Use the [libstored](https://demcon.github.io/libstored) generator to parse the `<name>.st` and output the `<name>Meta.py`.
-The `generator.py` script in this repository under `/python`
 
-Make sure a virtual environment is created, activated and the requirements.txt is installed in it.
-```bash
-cd python
-python -m venv .venv
-./.venv/Scripts/activate
-pip install -r requirements.txt
-```
-
-Call the generator script to create a C# store that implements the `Store` abstract class, which can then be mapped to the `Synchronizer` and `Debugger` in LibStored.Net.
+This project uses a C# Source Generator to create strongly-typed store classes from store metadata YAML (.yml) files at compile time. 
+This YAML file is automatically created when generating code for a store (.st) using [libstored](https://demcon.github.io/libstored) (from version v2.1.0).
 
-```bash
-python generator.py -m <name>Meta.py -o output_dir
-```
+How to use the Source Generator:
+- Add the store metadata files (*.yml) to your project as AdditionalFiles so the source generator can read them during compilation.
+- Reference the LibStored.Net either by adding the NuGet package. This package include the Source Generator.
+- The generator emits C# store classes implementing the `Store` base class. Use them directly from your code after a build.
 
-#### Source Generator
-
-The C# code can be automatically generated from a metadata`*.yml` file generated by the `generator.py` script (or in the future - see [libstored issue#76](https://github.com/DEMCON/libstored/issues/76)). Reference the store(s) metadata as AddinionalFiles:
+Example csproj snippet:
 ```xml
 <ItemGroup>
     <AdditionalFiles Include="TestStore.yml" />
@@ -116,15 +106,6 @@ Another option would be to create a store per thread, and synchronize them using
 - StdioLayer (use `libstored.Stdio2Zmq` as alternative for local debugging, not production ready)
 - SerialLayer (use `libstored.Serial2Zmq` as alternative for local debugging, not production ready)
 
-#### Store source generation
-Currently, C# stores are created manually by running a Python script using the Meta.py output of [libstored](demcon.github.io/libstored).
-A C# Source Generator could automate this process of converting the store data structure to a C# class, using the hash, names, types, offset and
-sizes of all objects in the store.
-
-A C# Source Generator could generate the stores automatically during compile-time of the C# application using this library. The input of the source generated is the `.rtf` / `.csv` / `Meta.py`, or parse the actual store definition in `.st` files. Maybe [libstored](demcon.github.io/libstored) can be extended to generate a language agnostic `.json` or `.yml` file with the store definition, which can be used by the C# Source Generator to generate the store class. The `.json` file would be the easiest to implement since its easy to parse and can contain all relevant store data. The Source Generator that transform a `*.yml` has been implemented, as described in the [README.md](src/LibStored.Net.Generator/README.md).
-
-Another option is to create a template file for the C# version of the store in [libstored](demcon.github.io/libstored).
-
 #### Unsupported features
 
 Types: `Pointer`, `Pointer32` and `Pointer64` are not supported, as they are not needed in C# applications. The `ptr32` and `ptr64` types are used to store pointers to other objects in the store, which is not needed in C# applications as the objects are stored in managed memory. These types will be mapped to unsigned integers (`uint` and `ulong`) in the C# implementation.
@@ -139,7 +120,7 @@ using LibStored.Net.ZeroMQ;
 using NetMQ;
 using NetMQ.Sockets;
 
-// Make sure this ExampleStore is created by the source generator or python script.
+// Make sure this ExampleStore is created by the source generator from ExampleStore.yml.
 ExampleStore store = new();
 
 // Attach the store to the debugger
@@ -173,6 +154,7 @@ python -m libstored.gui -p 5555
 ## Compatibility
 
 Tested with libstored versions:
+- [v2.1.0](https://github.com/DEMCON/libstored/releases/tag/v2.1.0)
 - [v2.0.0](https://github.com/DEMCON/libstored/releases/tag/v2.0.0)
 - [v1.8.0](https://github.com/DEMCON/libstored/releases/tag/v1.8.0)
 - [v1.7.1](https://github.com/DEMCON/libstored/releases/tag/v1.7.1) (see note below)