Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
drawbu committed Mar 25, 2024
1 parent f0ec571 commit 2595672
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,29 @@
> [!NOTE]
> This is a 2nd year project at [Epitech](https://epitech.eu/).

## Description

Arcade is a gaming platform: a program that lets the user choose a game to play
and keeps a register of player scores.

To be able to deal with the elements of your gaming plateform at run-time,
the graphics libraries and your games must be implemented as dynamic libraries,
loaded at run-time.

Each GUI available for the program must be used as a shared library that will
be loaded and used dynamically by the main program.


## Compilation

On *nix systems, you can compile the project using the following commands:
(the list of dependencies is abstract, so good luck figuring out)
```sh
cmake -S . -B build
cmake --build build
./build/nanotekspice Circuit.nts
./build/arcade
```
*All shared objects are built in lib/*

Or if you have `nix`, just use `nix run`.

0 comments on commit 2595672

Please sign in to comment.