summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKévin Le Gouguec <kevin.legouguec@airbus.com>2018-12-17 16:10:47 +0100
committerKévin Le Gouguec <kevin.legouguec@airbus.com>2018-12-17 16:11:34 +0100
commit31cb973c38c9d52142892081d579dde52f39ff63 (patch)
treeba6e7f717fc7ba18be9334c262772d01213b330d /README.md
parent4565bb0ccc1bcd9af0ac62f5df9a87c5717c9284 (diff)
downloadlilliput-ae-implem-31cb973c38c9d52142892081d579dde52f39ff63.tar.xz
Mise à jour de la documentation de l'implémentation de référence
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index 2890604..01dfefd 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,18 @@ It is organized as follows:
`src`
-----
-Contains parameter-independent code for the reference implementation:
+Contains two kinds of subfolders:
+
+- implementations: parameter-independent code
+ - `ref`: the reference implementation
+ - `add_*`: additional implementations
+
+- parameters: one folder for each variant of the Lilliput-AE family,
+ named `${mode}-${keybits}`:
+ - mode is either i (for ΘCB3) or ii (for SCT-2)
+ - keybits is either 128, 192 or 256
+
+Each implementation folder contains:
- `lilliput-ae.h`: main API
- `lilliput-ae-i.c`: implementation of Lilliput-Ⅰ (ΘCB3-based)
@@ -20,12 +31,6 @@ Contains parameter-independent code for the reference implementation:
- `parameters.h`: byte sizes for inputs and outputs (depends on
parameter-dependent `_parameters.h` files)
-There is one subfolder for each variant of the Lilliput-AE family,
-named `${mode}-${keybits}`:
-
-- mode is either i (for ΘCB3) or ii (for SCT-2)
-- keybits is either 128, 192 or 256
-
`test`
-------------