-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add documentation about installations and build
- Loading branch information
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |