Merge pull request #3 from G-Epitech/pre-commit

config: add pre-commit config

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: local
+    hooks:
+    - id: tests_run
+      name: Run tests
+      entry: bash -c 'make tests_run'
+      language: system
+      pass_filenames: false

README.md

@@ -1,2 +1,34 @@
 # FMY-Arcade
 🖲️ Retro Platform
+
+## Installation
+### Cmake
+```
+sudo apt install cmake
+```
+More informations [here](https://cmake.org/download/).
+
+### Pre-Commit
+First, install pre-commit package.
+- On linux:
+```
+pip install pre-commit
+```
+- On macOS (Intel/AMD):
+```
+brew install pre-commit
+```
+Next, steup pre-commit at the root of the repository:
+```
+pre-commit install
+```
+
+## Build project
+Build the project
+```
+make
+```
+Clean the project
+```
+make fclean
+```