Skip to content

Commit

Permalink
docs: add documentation about installations and build
Browse files Browse the repository at this point in the history
  • Loading branch information
TekMath committed Mar 11, 2024
1 parent b756005 commit 09dbcc6
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
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
```

0 comments on commit 09dbcc6

Please sign in to comment.