arrdem/source
1
0
Fork 0
Code Issues 11 Pull requests Projects Releases Packages Wiki Activity

Extend the docs a touch

Browse source
This commit is contained in:
Reid 'arrdem' McKenzie 2021-08-03 19:33:10 -06:00
parent e74d9af4fa
commit d51eb85fa1
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
projects/proquint/README.md
View file

@ -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. 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. 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 ## Demo
@ -24,17 +28,17 @@ The proquint format is a semantically dense coding for 16 bit hunks fitting with
### `proquint.Proquint.CONSONANTS` ### `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. Must be of length 16.
### `proquint.Proquint.VOWELS` ### `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. Must be of length 4.
### `proquint.Proquint.decode(buffer: str) -> int` ### `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` ### `proquint.Proquint.encode(val: int, width: int) -> str`