diff options
| author | J08nY | 2022-12-28 16:56:21 +0100 |
|---|---|---|
| committer | J08nY | 2022-12-28 16:56:21 +0100 |
| commit | e987a7568e3d6da19d852fee24e0d4d4425193bd (patch) | |
| tree | 9b097f7471f5a750462f9c2850d04684fcb78f6e | |
| parent | 6f770fdac1d72eae88f0bf24f080362b07a2dd52 (diff) | |
| download | pyecsca-codegen-e987a7568e3d6da19d852fee24e0d4d4425193bd.tar.gz pyecsca-codegen-e987a7568e3d6da19d852fee24e0d4d4425193bd.tar.zst pyecsca-codegen-e987a7568e3d6da19d852fee24e0d4d4425193bd.zip | |
Add some docs on installation.
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/INSTALL.md | 16 |
2 files changed, 19 insertions, 1 deletions
@@ -6,6 +6,8 @@ Codegen package. See the [main repo](https://github.com/J08nY/pyecsca) for more information. +See [INSTALL](docs/INSTALL.md) for installation instructions. + ## License MIT License @@ -32,4 +34,4 @@ Codegen package. See the [main repo](https://github.com/J08nY/pyecsca) for more *Development is supported by the Masaryk University grant [MUNI/C/1701/2018](https://www.muni.cz/en/research/projects/46834), -this support is very appreciated.*
\ No newline at end of file +this support is very appreciated.* 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. |