preserves-nim/README.md

# Preserves

Nim implementation of the [Preserves data language](https://preserves.dev/).

If you don't know why you need Preserves, see the [Syndicate library](https://git.syndicate-lang.org/ehmry/syndicate-nim).

## Library

To parse or produce Preserves one should write a [schema](https://preserves.dev/preserves-schema.html) and generate a Nim module using the [preserves_schema_nim](./src/preserves/preserves_schema_nim.nim) utility. This module will contain Nim types corresponding to schema definitions. The `toPreserve` and`fromPreserve` routines will convert Nim types to and from Preserves. The `decodePreserves`, `parsePreserves`, `encode`, and `$` routines will convert `Preserve` objects to and from binary and textual encoding.

To debug the `toPreserves` and `fromPreserves` routines compile with `-d:tracePreserves`.

## Utilities
* preserves_schema_nim
* preserves_encode
* preserves_decode
* preserves_from_json
* preserves_to_json

### Installation
`preserves_encode` is a multi-call binary that implements `preserves_encode`, `preserves_decode`, `preserves_from_json`, and `preserves_to_json`, so the appropriate symlinks should be created during packaging.
Update documentation 2021-10-25 17:07:16 +00:00			`# Preserves`

Update upstream URLs 2022-05-24 12:02:56 +00:00			`Nim implementation of the [Preserves data language](https://preserves.dev/).`
Add some utilities 2021-09-08 09:11:54 +00:00
Add note on syndicate-nim to README 2023-04-06 01:05:42 +00:00			`If you don't know why you need Preserves, see the [Syndicate library](https://git.syndicate-lang.org/ehmry/syndicate-nim).`

Update documentation 2021-10-25 17:07:16 +00:00			`## Library`

Update upstream URLs 2022-05-24 12:02:56 +00:00			To parse or produce Preserves one should write a [schema](https://preserves.dev/preserves-schema.html) and generate a Nim module using the [preserves_schema_nim](./src/preserves/preserves_schema_nim.nim) utility. This module will contain Nim types corresponding to schema definitions. The `toPreserve` and`fromPreserve` routines will convert Nim types to and from Preserves. The `decodePreserves`, `parsePreserves`, `encode`, and `$` routines will convert `Preserve` objects to and from binary and textual encoding.
Update documentation 2021-10-25 17:07:16 +00:00
Update upstream URLs 2022-05-24 12:02:56 +00:00			To debug the `toPreserves` and `fromPreserves` routines compile with `-d:tracePreserves`.
Update documentation 2021-10-25 17:07:16 +00:00
Add some utilities 2021-09-08 09:11:54 +00:00			`## Utilities`
			`* preserves_schema_nim`
			`* preserves_encode`
			`* preserves_decode`
			`* preserves_from_json`
			`* preserves_to_json`

Update documentation 2021-10-25 17:07:16 +00:00			`### Installation`
Update upstream URLs 2022-05-24 12:02:56 +00:00			`preserves_encode` is a multi-call binary that implements `preserves_encode`, `preserves_decode`, `preserves_from_json`, and `preserves_to_json`, so the appropriate symlinks should be created during packaging.