Update upstream URLs
This commit is contained in:
parent
5043d8595a
commit
55da079955
17
README.md
17
README.md
|
@ -1,19 +1,12 @@
|
||||||
# Preserves
|
# 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
|
## Library
|
||||||
|
|
||||||
To parse or produce Preserves one should write a
|
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.
|
||||||
[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 debug the `toPreserves` and `fromPreserves` routines compile with
|
To debug the `toPreserves` and `fromPreserves` routines compile with `-d:tracePreserves`.
|
||||||
`-d:tracePreserves`.
|
|
||||||
|
|
||||||
## Utilities
|
## Utilities
|
||||||
* preserves_schema_nim
|
* preserves_schema_nim
|
||||||
|
@ -23,6 +16,4 @@ To debug the `toPreserves` and `fromPreserves` routines compile with
|
||||||
* preserves_to_json
|
* preserves_to_json
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
`preserves_encode` is a multi-call binary that implements `preserves_encode`,
|
`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_decode`, `preserves_from_json`, and `preserves_to_json`, so the
|
|
||||||
appropriate symlinks should be created during packaging.
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Package
|
# 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"
|
author = "Emery Hemingway"
|
||||||
description = "data model and serialization format"
|
description = "data model and serialization format"
|
||||||
license = "Unlicense"
|
license = "Unlicense"
|
||||||
|
|
Loading…
Reference in New Issue