<p align="center"><img src="./ressources/Black.svg" width="400"></p>

<p align="center">
  <a href="./LICENSE"><img src="https://img.shields.io/github/license/AnonymusRaccoon/ComSquare?style=flat-square" alt="License"></a>
  <a href="https://github.com/AnonymusRaccoon/ComSquare/issues"><img src="https://img.shields.io/github/issues/AnonymusRaccoon/ComSquare?style=flat-square" alt="Issues"></a>
  <a href="https://github.com/AnonymusRaccoon/ComSquare/actions?query=workflow%3A%22Build+commit+artifact%22"><img src="https://img.shields.io/github/workflow/status/AnonymusRaccoon/ComSquare/Build%20commit%20artifact?style=flat-square" alt="Artifact"></a>
  <a href="https://github.com/AnonymusRaccoon/ComSquare/actions?query=workflow%3A%22Testing+current+commit%22"><img src="https://img.shields.io/github/workflow/status/AnonymusRaccoon/ComSquare/Testing%20current%20commit?label=tests&style=flat-square" alt="Testing"></a>
  <a href="https://codecov.io/gh/AnonymusRaccoon/ComSquare"><img src="https://img.shields.io/codecov/c/gh/AnonymusRaccoon/ComSquare?style=flat-square" alt="CodeCov"></a>
</p>


Com² is a SNES emulator for Linux built in C++ by 3 friends.

***

## Installation

You can use an artifact from latest commit by selecting ✔️ and ``Build commit artifact``. You will have an option, if the commit is correct, to download the artifact which you have to unzip.


Overwhise, you can build yourself the program by cloning the repository : ``git clone https://github.com/AnonymusRaccoon/ComSquare.git``

You need the [SFML library](https://www.sfml-dev.org/download.php).

After going inside the repository directory, create a build folder ``mkdir build``, go inside and make ``cmake ..`` to finally make ``make``. If you've done nothing wrong, you should have the program compiled!


## Informations

During the development we will update and create documentations about the SNES and the emulator, we will use [GitHub Projects](https://github.com/AnonymusRaccoon/ComSquare/projects) page and [GitHub Wiki](https://github.com/AnonymusRaccoon/ComSquare/wiki) to inform you about "everything".
The documentation can be found to [ComSquare Documentation](https://anonymusraccoon.github.io/ComSquare/) 

### Licence

As seen on the badge, we use [GPLv3 license](./LICENSE), so you're free to use, fork and modify our program freely, we are 100% Open Source!
