More descriptive READMEs

diff --git a/README b/README
index 71ead09073fe1d56f3b1da766bdd1a5fa7be6b3fa60c93d1542bef3512188ba6..60f10a817e01d4e911ba9e8c8141da71afc50fdab44f426075434e8392eb9ded 100644 (file)
--- 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 8678b056138a4968a2c7b46f249e21a58bc117506625a2a49580f439462a7628..c5375c96d5dfc99076f06c90f20a8e40330d8c79814f908e895d0c6f9ce4648c 100644 (file)
--- 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 (file)
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 7d3ba5da14affb98019c133c9374ba686036d5e9973092be274355da0a51a7c5..348dee5432afb1f6b9c2b8442009f4efec0ea57b439376e6563d74d00fdd42a4 100644 (file)
--- 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 6098c7eb100286df936c51eb89279ad574b79c0cbebde0c028b059f4e70e6a52..b45bcd789aaa3ffecc42c2614cfae28f6c388d92d20f4a54109de51bb3ad90dc 100644 (file)
--- 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 ba005603269123dc5a6fe44c58fb11439519cabed6c4e19864482a7e84d85243..6d2288bd3e150d2391fab83347f88adc0b2c7cf7f6b495371509e118e9e30db5 100644 (file)
--- 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.