aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorJ08nY2022-12-28 16:56:21 +0100
committerJ08nY2022-12-28 16:56:21 +0100
commite987a7568e3d6da19d852fee24e0d4d4425193bd (patch)
tree9b097f7471f5a750462f9c2850d04684fcb78f6e /docs
parent6f770fdac1d72eae88f0bf24f080362b07a2dd52 (diff)
downloadpyecsca-codegen-e987a7568e3d6da19d852fee24e0d4d4425193bd.tar.gz
pyecsca-codegen-e987a7568e3d6da19d852fee24e0d4d4425193bd.tar.zst
pyecsca-codegen-e987a7568e3d6da19d852fee24e0d4d4425193bd.zip
Add some docs on installation.
Diffstat (limited to 'docs')
-rw-r--r--docs/INSTALL.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
new file mode 100644
index 0000000..7533529
--- /dev/null
+++ b/docs/INSTALL.md
@@ -0,0 +1,16 @@
+# Installation
+
+This assumes that both *pyecsca* and the *pyecsca-codegen*
+packages are installed as editable.
+
+1. Checkout the ext/libtommath submodule:
+`git submodule update --init`
+2. Build the libtommath library to prepare it for the future
+build processes steps.
+```
+cd ext
+make host stm32f0 stm32f3
+```
+
+Now the package should be ready with the necessary versions of
+libtommath built for the host and the STM32F0 and F3 targets.