chore: update readme
This commit is contained in:
@@ -6,8 +6,6 @@
|
|||||||
|
|
||||||
Binary serialization code generator for Go and C#. Define messages once as Go structs — get zero-allocation `Marshal`/`Unmarshal` for Go and `unsafe` pointer-based `Serialize`/`Deserialize` for C#.
|
Binary serialization code generator for Go and C#. Define messages once as Go structs — get zero-allocation `Marshal`/`Unmarshal` for Go and `unsafe` pointer-based `Serialize`/`Deserialize` for C#.
|
||||||
|
|
||||||
Built for game networking where every byte and allocation matters.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Single source of truth** — define messages in Go, generate both Go and C# code
|
- **Single source of truth** — define messages in Go, generate both Go and C# code
|
||||||
@@ -36,8 +34,6 @@ arpack -in messages.go -out-go ./gen -out-cs ../Unity/Assets/Scripts
|
|||||||
| `-out-cs` | Output directory for generated C# code |
|
| `-out-cs` | Output directory for generated C# code |
|
||||||
| `-cs-namespace` | C# namespace (default: `Arpack.Messages`) |
|
| `-cs-namespace` | C# namespace (default: `Arpack.Messages`) |
|
||||||
|
|
||||||
At least one of `-out-go` or `-out-cs` is required.
|
|
||||||
|
|
||||||
**Output files:**
|
**Output files:**
|
||||||
- Go: `{name}_gen.go`
|
- Go: `{name}_gen.go`
|
||||||
- C#: `{Name}.gen.cs`
|
- C#: `{Name}.gen.cs`
|
||||||
@@ -138,9 +134,9 @@ Uses unsafe pointers for zero-copy serialization. Returns bytes written/consumed
|
|||||||
## Running Tests
|
## Running Tests
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Unit tests (parser + generator)
|
# Unit tests
|
||||||
go test ./parser/... ./generator/...
|
go test ./parser/... ./generator/...
|
||||||
|
|
||||||
# End-to-end cross-language tests (requires dotnet SDK)
|
# End-to-end cross-language tests
|
||||||
go test ./e2e/...
|
go test ./e2e/...
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user