From 31b66bb0a588cd91deadbbf17602fbf58f16cf16b5adde08c077ada3cd12bd8c Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Wed, 25 Jun 2025 15:05:00 +0300 Subject: [PATCH] More descriptive READMEs --- README | 18 +++++++++++++++--- c/README | 6 ++++-- go/INSTALL | 1 + go/README | 2 +- spec/INSTALL | 2 +- tcl/README | 2 +- 6 files changed, 23 insertions(+), 8 deletions(-) create mode 100644 go/INSTALL diff --git a/README b/README index 71ead09..60f10a8 100644 --- a/README +++ b/README @@ -2,13 +2,25 @@ KEKS is compact, deterministic, concise and streaming binary serialisation format. It is aimed to be lightweight in terms of CPU, memory, storage and codec implementation size usage. It supports wide range of data types, making it able to transparently replace JSON. + KEKS/Schema is a schema definition format for describing data structures validation steps. + KEKS/CM is a set of schemas and formats related to cryptographic tasks like signing, hashing and encryption. -This repository contains implementations of KEKS codec on C99, Go, -Python3 and Tcl (only encoder) languages. Implementation of KEKS/Schema -on Tcl. Implementations of KEKS/CM and related utilities on C and Go. +spec/ directory contains specifications of the KEKS, KEKS/Schema, +KEKS/CM, KEKS/RPC and homepage website contents. + +c/ directory contains implementation of KEKS encoder/decoder, +KEKS/Schema interpreter and example KEKS/CM code in C99. + +go/ directory contains implementation of KEKS encoder/decoder, +KEKS/Schema interpreter and various KEKS/CM utilities in Go. + +py3/ directory contains implementation of KEKS encoder/decoder in Python3. + +tcl/ directory contains implementation of KEKS encoder and KEKS/Schema +converter in Tcl. tcl/schemas/ contains various schemas. Home page: http://www.keks.cypherpunks.su/ diff --git a/c/README b/c/README index 8678b05..c5375c9 100644 --- a/c/README +++ b/c/README @@ -1,2 +1,4 @@ -C99 implementation of the KEKS codec, KEKS/Schema validator and -part of KEKS/CM. Look at doc/ for more information. +C99 implementation of the KEKS encoder/decoder, KEKS/Schema interpreter +and KEKS/CM subset. Look at doc/keks.info for more information. + +It is free software: see the file COPYING.LESSER for copying conditions. diff --git a/go/INSTALL b/go/INSTALL new file mode 100644 index 0000000..d35f41b --- /dev/null +++ b/go/INSTALL @@ -0,0 +1 @@ +Use utils/mk-bin and cm/utils/mk-bin to build utilities in bin/. diff --git a/go/README b/go/README index 7d3ba5d..348dee5 100644 --- a/go/README +++ b/go/README @@ -1,4 +1,4 @@ -Go implementation of the KEKS codec, KEKS/Schema validator and KEKS/CM. +Go implementation of the KEKS codec, KEKS/Schema interpreter and KEKS/CM. Partial FLOAT support. diff --git a/spec/INSTALL b/spec/INSTALL index 6098c7e..b45bcd7 100644 --- a/spec/INSTALL +++ b/spec/INSTALL @@ -1,4 +1,4 @@ -Currently there are draft versions of the codec written on +Currently there are draft versions of the codec written in C99, Go, Python3 and Tcl. You can obtain development source code with: diff --git a/tcl/README b/tcl/README index ba00560..6d2288b 100644 --- a/tcl/README +++ b/tcl/README @@ -1,3 +1,3 @@ -Tcl implementation of the KEKS encoder. +Tcl implementation of the KEKS encoder and KEKS/Schema converter. It is free software: see the file COPYING.LESSER for copying conditions. -- 2.50.0