Skip to content
Snippets Groups Projects
README.md 1.19 KiB
Newer Older
Cyril Moineau's avatar
Cyril Moineau committed
# Aidge

[![License-badge](https://img.shields.io/badge/License-EPL%202.0-blue.svg)](LICENSE)

description du framework

peut etre mettre mention a deepgreen

## Installation

### Build on Linux

To build manually Aidge on Linux, go at the root of the project and run in your python environment
```
pip install . -v
```


Cyril Moineau's avatar
Cyril Moineau committed
## Docker Image

Feel free to use one of the Dockerfiles available in the [`docker`](docker) folder.

To build the image, run where your DockerFile is
```
docker build --pull --rm -f "name_of_os.Dockerfile" -t aidge:myenv .
```

Then to run a container, run
```
docker run --name mycontainer aidge:myenv
```

Cyril Moineau's avatar
Cyril Moineau committed
## Contributing

If you would like to contribute to the Aidge project, we’re happy to have your help!
Everyone is welcome to contribute code via merge requests, to file issues on Gitlab,
to help people asking for help, fix bugs that people have filed,
to add to our documentation, or to help out in any other way.
We grant commit access (which includes full rights to the issue database, such as being able to edit labels)
to people who have gained our trust and demonstrated a commitment to Aidge.

Cyril Moineau's avatar
Cyril Moineau committed
## License

Aidge has a Eclipse Public License 2.0, as found in the [LICENSE](LICENSE).