@@ -9,26 +9,54 @@ scared is a side-channel analysis framework.
## Getting started
### Pre-requisites
### Requirements
To use scared, you will need the the following Python **3.6** or **3.7**.
Scared need python **3.6**, **3.7** or **3.8**.
If your configuration has a binary build available ([see list here](#binary-builds-available)), you can just run:
You can install `scared`, depending on your setup:
- from source
- with `pip`
- with `conda`
>At time of writing, we highly recommend to install `scared` with `conda` if you want to use it with **python 3.8**
#### Install with `conda`
Conda builds are available for `linux-x64` and `osx-64` platforms.
If your system isn't yet supported, [build contributions are welcome!](./CONTRIBUTING.md#building-for-conda)).
You just have to run:
```bash
pipinstall scared
condainstall-c eshard scared
```
#### Install with `pip`
Binary builds are available from Pypi for most Linux platforms and OS X. If your environment has a binary build available, just run:
```bash
condainstall-c eshard scared
pipinstall scared
```
If your system isn't yet supported ([build contributions are welcome!](./CONTRIBUTING.md#building-for-conda)), or you want to build from source, you'll also need:
If no wheel is available for your setup, you'll also need:
- setuptools **0.40 or greater** (just run `pip install -U pip setuptools`)
- a C compiler to compile C extension
- for **Python 3.8** only, a `llvmlite` working installation (see [install from source documentation](https://llvmlite.readthedocs.io/en/latest/admin-guide/install.html#building-manually))
and then run `pip install scared`.
#### Install from source
To install from source, you will need:
- setuptools **0.40 or greater** (just run `pip install -U pip setuptools`)
- a C compiler to compile C extension
- for **Python 3.8** only, a `llvmlite` working installation (see [install from source documentation](https://llvmlite.readthedocs.io/en/latest/admin-guide/install.html#building-manually), or install it with `conda`)