Skip to content

Commit 26edecd

Browse files
Update README.md
1 parent e5b188a commit 26edecd

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66

77
A small library to represent and generate arbitrarily complex objects using a flat `float[]`-useful for procedural generation, genetic algorithms, parameter optimization, and compact serialization of parameter spaces.
88

9-
> Parameterize.Net lets you define the *shape* of an object declaratively (attributes or fluent builder), derive a `Resolver` that maps between a `float[]` (a “gene”) and concrete instances, and query ranges and mutation-friendly values for use in genetic/optimization workflows. ([GitHub][1])
9+
> Parameterize.Net lets you define the *shape* of an object declaratively (attributes or fluent builder), derive a `Resolver` that maps between a `float[]` (a “gene”) and concrete instances, and query ranges and mutation-friendly values for use in genetic/optimization workflows.
1010
1111
---
1212

1313
## Status & Compatibility
1414

15-
* Current package: **Parameterize.Net 2.0.0**. Targets **.NET Standard 2.1** (compatible with .NET 5/6/7/8/9/10 and a variety of platforms). ([NuGet][2])
16-
* Language: **C#**. Repository contains source and examples. ([GitHub][1])
17-
* License: **MIT**. ([GitHub][1])
15+
* Current package: **Parameterize.Net 2.0.0**. Targets **.NET Standard 2.1** (compatible with .NET 5/6/7/8/9/10 and a variety of platforms).
16+
* Language: **C#**. Repository contains source and examples.
17+
* License: **MIT**.
1818

1919
---
2020

@@ -26,7 +26,7 @@ A small library to represent and generate arbitrarily complex objects using a fl
2626
* **Declarative model (attributes)** - annotate your classes with `[Parameterize]`, `[Range(min,max)]`, `[Length(min,max)]`, `[Subtype(typeof(...))]`, `[Resolver(typeof(...))]` and the library will derive a `Resolver` for your type.
2727
* **Programmatic model (ResolverBuilder)** - build resolvers explicitly in code for maximum control (good for generated code, editor tooling, or when you prefer fluent definitions).
2828

29-
(These concepts and examples are implemented and demonstrated in the repository README and examples.) ([GitHub][1])
29+
(These concepts and examples are implemented and demonstrated in the repository README and examples.)
3030

3131
---
3232

@@ -38,7 +38,7 @@ A small library to represent and generate arbitrarily complex objects using a fl
3838
dotnet add package Parameterize.Net --version 2.0.0
3939
```
4040

41-
Package targets `.NET Standard 2.1` - see NuGet for details about supported platform compatibility. ([NuGet][2])
41+
Package targets `.NET Standard 2.1` - see NuGet for details about supported platform compatibility.
4242

4343
### Unity
4444

@@ -48,7 +48,7 @@ Use Unity Package Manager → **Add package from git URL** and paste:
4848
https://github.com/PasoUnleashed/Parameterize.Net.git?path=/Parameterize.Net/Parameterize.Net/Source#main
4949
```
5050

51-
(This points the Unity package manager to the package path inside the repo.) ([GitHub][1])
51+
(This points the Unity package manager to the package path inside the repo.)
5252

5353
---
5454

@@ -104,7 +104,7 @@ var zoo = resolver.Resolve<Zoo>(gene); // create an instance from gene
104104
Console.WriteLine(zoo);
105105
```
106106

107-
This yields a `Zoo` instance with randomized animals according to the constraints. ([GitHub][1])
107+
This yields a `Zoo` instance with randomized animals according to the constraints.
108108

109109
---
110110

@@ -242,7 +242,7 @@ If you want, I can **also create a side-by-side comparison of attribute-based vs
242242
* `[Subtype(typeof(...))]` - polymorphic choices for arrays/lists of base types
243243
* `[Resolver(typeof(YourResolver))]` - attach a custom resolver to a field/property
244244

245-
(Examples and attribute usage are shown in the repository README.) ([GitHub][1])
245+
(Examples and attribute usage are shown in the repository README.)
246246

247247
---
248248

@@ -276,13 +276,13 @@ This design aims for a deterministic mapping: the same gene should resolve to th
276276

277277
## Dependencies
278278

279-
* The NuGet package lists `Newtonsoft.Json` (>= 13.0.3) in its package dependencies. Check the package metadata for exact versions. ([NuGet][2])
279+
* The NuGet package lists `Newtonsoft.Json` (>= 13.0.3) in its package dependencies. Check the package metadata for exact versions.
280280

281281
---
282282

283283
## Examples & snippets
284284

285-
* The repository README includes a compact demo (the `Zoo` example) which demonstrates both attribute-based and fluent-builder approaches. Use the examples as a starting point to integrate Parameterize.Net into your project. ([GitHub][1])
285+
* The repository README includes a compact demo (the `Zoo` example) which demonstrates both attribute-based and fluent-builder approaches. Use the examples as a starting point to integrate Parameterize.Net into your project.
286286

287287
---
288288

@@ -297,23 +297,23 @@ This design aims for a deterministic mapping: the same gene should resolve to th
297297
## FAQ
298298

299299
**Q: Is Parameterize.Net a serializer?**
300-
A: Not exactly. It's a parameterization layer that maps between compact float gene vectors and instances. While you can use it to serialize parameter space, its main use is generation and optimization workflows (procedural content, GA-like systems). ([GitHub][1])
300+
A: Not exactly. It's a parameterization layer that maps between compact float gene vectors and instances. While you can use it to serialize parameter space, its main use is generation and optimization workflows (procedural content, GA-like systems).
301301

302302
**Q: Can I persist genes to disk?**
303303
A: Yes - genes are just arrays of floats. Persist the array (binary or text) and re-load to `Resolve<T>` the same object.
304304

305305
**Q: Does it work in Unity?**
306-
A: Yes - the repo includes Unity-compatible packaging instructions (use Unity Package Manager with the git URL path). ([GitHub][1])
306+
A: Yes - the repo includes Unity-compatible packaging instructions (use Unity Package Manager with the git URL path).
307307

308308
---
309309

310310
## License
311311

312-
MIT. See `LICENSE` in the repository. ([GitHub][1])
312+
MIT. See `LICENSE` in the repository.
313313

314314
---
315315

316316
## Contact & resources
317317

318-
* Source repository: PasoUnleashed / Parameterize.Net (see repo for code & examples). ([GitHub][1])
319-
* NuGet package & versioning: Parameterize.Net on NuGet (current version & supported TFMs). ([NuGet][2])
318+
* Source repository: PasoUnleashed / Parameterize.Net (see repo for code & examples).
319+
* NuGet package & versioning: Parameterize.Net on NuGet (current version & supported TFMs).

0 commit comments

Comments
 (0)