From dd11341818ef9d14e9d4e8defa3623472164d4fb Mon Sep 17 00:00:00 2001 From: ElNiak Date: Wed, 5 Jun 2024 14:47:05 +0200 Subject: [PATCH] install pre-commit --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 29bab3cfa..b5d9a0de7 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ [![Python application](https://github.com/csvl/SEMA-ToolChain/actions/workflows/python-app.yml/badge.svg)](https://github.com/csvl/SEMA-ToolChain/actions/workflows/python-app.yml) -![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54) ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white) ! ![Debian](https://img.shields.io/badge/Debian-D70A53?style=for-the-badge&logo=debian&logoColor=white) +![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54) ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white) ![Debian](https://img.shields.io/badge/Debian-D70A53?style=for-the-badge&logo=debian&logoColor=white) ### Toolchain architecture @@ -46,6 +46,15 @@ Another classifier we use is the Support Vector Machine (`SVM`) with INRIA graph A web application is available and is called SemaWebApp. It allows to manage the launch of experiments on SemaSCDG and/or SemaClassifier. +### Pre-commit + +This repository uses pre-commit to ensure that the code is formatted correctly and that the code is clean. To install pre-commit, run the following command: + +```bash +python3 -m pip install pre-commit +pre-commit install +``` + ### Documentation * Complete README of the entire toolchain : ![Sema README](./doc/README.md)