Commit 09c36096 authored by Rémi Huguet's avatar Rémi Huguet
Browse files

maint: add instructions for python 3.8 support

parent 6b44dc58
Loading
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
python:
  - 3.6
  - 3.7
  - 3.8
+3 −3
Original line number Diff line number Diff line
@@ -117,14 +117,14 @@ For code contributions, please follows these guidelines.

#### Requirements

All developments should be compatible with **Python 3.6** and **3.7**.
All developments should be compatible with **Python 3.6+** versions.

To develop, you'll need to support:
To develop, you'll need to have:

- setuptools **0.40 or greater** (just run `pip install -U pip setuptools`)
- a C compiler to compile C extension with Cython (see Cython documentation)

To start runnning your test suite, you can install the library in development mode:
To start runnning your test suite, you must install the library in development mode:

```bash
pip install -e .
+36 −7
Original line number Diff line number Diff line
@@ -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
pip install scared
conda install -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
conda install -c eshard scared
pip install 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`)

To install from source, you just need to run:
You need to run:

```bash
pip install .
@@ -105,3 +133,4 @@ Python version:

- 3.6
- 3.7
- 3.8 from `conda`, or buy building from sources.