From 09dbcc684d700b9485b19f8e74f4a77a1c354829 Mon Sep 17 00:00:00 2001 From: Matheo Coquet Date: Mon, 11 Mar 2024 16:15:35 +0100 Subject: [PATCH] docs: add documentation about installations and build --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 9f8c254..d82fd8f 100644 --- a/README.md +++ b/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 +```