zoriya/ComSquare
1
0
Fork 0
mirror of https://github.com/zoriya/ComSquare.git synced 2026-05-14 11:45:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
ComSquare/md_README.html
AnonymusRaccoon d33b0ab52d Deploying the doc
2021-07-13 21:32:24 +00:00

96 lines
5.6 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ComSquare: README</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ComSquare
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">README </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p align="center"></p>
<p><object type="image/svg+xml" data="./resources/Black.svg" style="pointer-events: none;" width="400"></object></p>
<p align="center"></p>
<p><a href="./LICENSE"><img src="https://img.shields.io/github/license/AnonymusRaccoon/ComSquare?style=flat-square" alt="License" class="inline"/></a> <a href="https://github.com/AnonymusRaccoon/ComSquare/issues"><img src="https://img.shields.io/github/issues/AnonymusRaccoon/ComSquare?style=flat-square" alt="Issues" class="inline"/></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" class="inline"/></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&amp;style=flat-square" alt="Testing" class="inline"/></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" class="inline"/></a> </p>
<p>Com² is a SNES emulator for Linux built in C++ by 3 friends.</p>
<hr />
<h2><a class="anchor" id="autotoc_md0"></a>
Installation</h2>
<p>You can use an artifact from latest commit by selecting ✔️ and <code>Build commit artifact</code>. You will have an option, if the commit is correct, to download the artifact which you have to unzip.</p>
<p>Overwhise, you can build yourself the program by cloning the repository : <code>git clone <a href="https://github.com/AnonymusRaccoon/ComSquare.git">https://github.com/AnonymusRaccoon/ComSquare.git</a></code></p>
<p>You need the <a href="https://www.sfml-dev.org/download.php">SFML library</a>.</p>
<p>After going inside the repository directory, create a build folder <code>mkdir build</code>, go inside and make <code>cmake ..</code> to finally make <code>make</code>. If you've done nothing wrong, you should have the program compiled!</p>
<h2><a class="anchor" id="autotoc_md1"></a>
Informations</h2>
<p>During the development we will update and create documentations about the SNES and the emulator, we will use <a href="https://github.com/AnonymusRaccoon/ComSquare/projects">GitHub Projects</a> page and <a href="https://github.com/AnonymusRaccoon/ComSquare/wiki">GitHub Wiki</a> to inform you about "everything". The documentation can be found to <a href="https://anonymusraccoon.github.io/ComSquare/">ComSquare Documentation</a></p>
<h3><a class="anchor" id="autotoc_md2"></a>
Licence</h3>
<p>As seen on the badge, we use <a href="./LICENSE">GPLv3 license</a>, so you're free to use, fork and modify our program freely, we are 100% Open Source! </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink