ehmry
/
preserves-nim
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update upstream URLs

This commit is contained in:
Emery Hemingway 2022-05-24 07:02:56 -05:00
parent 5043d8595a
commit 55da079955
2 changed files with 5 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,19 +1,12 @@
# Preserves
Nim implementation of the [Preserves data language](https://preserves.gitlab.io/preserves/preserves.html).
Nim implementation of the [Preserves data language](https://preserves.dev/).
## Library
To parse or produce Preserves one should write a
[schema](https://preserves.gitlab.io/preserves/preserves-schema.html) and
generate a Nim module using the `preserves_schema_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 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`.
To debug the `toPreserves` and `fromPreserves` routines compile with `-d:tracePreserves`.
## Utilities
* preserves_schema_nim
@ -23,6 +16,4 @@ To debug the `toPreserves` and `fromPreserves` routines compile with
* 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.
`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.

2
preserves.nimble
View File

@ -1,6 +1,6 @@
# Package
version = "3.3.1" # versioned in git, this version is just to confuse nimble
version = "3.3.2" # versioned in git, this version is just to confuse nimble
author = "Emery Hemingway"
description = "data model and serialization format"
license = "Unlicense"