zoriya/ComSquare
1
0
Fork 0
mirror of https://github.com/zoriya/ComSquare.git synced 2026-06-03 18:31:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding License and ReadMe

Browse Source
This commit is contained in:
Melefo
2020-01-21 12:29:32 +01:00
parent 2145c6ce53
commit 4e6733f4e9
4 changed files with 710 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+34
View File
@@ -0,0 +1,34 @@
<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 [SDL library](https://www.libsdl.org/).
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".
### 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!