From d51eb85fa14fffe9a383c9f80390f20f2b20c0b8 Mon Sep 17 00:00:00 2001 From: Reid 'arrdem' McKenzie <me@arrdem.com> Date: Tue, 3 Aug 2021 19:33:10 -0600 Subject: [PATCH] Extend the docs a touch --- projects/proquint/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/projects/proquint/README.md b/projects/proquint/README.md index d16fa68..d71565b 100644 --- a/projects/proquint/README.md +++ b/projects/proquint/README.md @@ -4,7 +4,11 @@ An implementation of [A Proposal for Proquints](https://arxiv.org/html/0901.4016 To summarize the paper, traditional decimal and hexadecimal codings are inconvenient for "large" bit-width identifiers. Decimal and hexadecimal codings offer no obvious dense enunciation and are traditionally presented without segmentation punctuation. -The proquint format is a semantically dense coding for 16 bit hunks fitting within the enunciable space of English. +The proquint (abbreviated **qint**) format is a semantically dense coding for 16 bit hunks fitting within the enunciable space of English. + +This implementation differs from [the reference implementation](https://github.com/dsw/proquint/tree/master/python) in that it presents a more pythonic and less c-derived API. +This implementation features support for arbitrary bit-width qints. +It also enables altering the dictionary, should the user decide to choose a different one. ## Demo @@ -24,17 +28,17 @@ The proquint format is a semantically dense coding for 16 bit hunks fitting with ### `proquint.Proquint.CONSONANTS` -A string of consonants to use when encoding or decoding proquints. +A string of consonants to use when encoding or decoding qints. Must be of length 16. ### `proquint.Proquint.VOWELS` -A string of vowels to use when encoding or decoding proquints. +A string of vowels to use when encoding or decoding qints. Must be of length 4. ### `proquint.Proquint.decode(buffer: str) -> int` -Decode a proquint string to an integer value without restriction on bit-width. +Decode a qint string to an integer value without restriction on bit-width. ### `proquint.Proquint.encode(val: int, width: int) -> str`