Files
ComSquare/latex/md_README.tex
AnonymusRaccoon d33b0ab52d Deploying the doc
2021-07-13 21:32:24 +00:00

21 lines
2.2 KiB
TeX

\href{./LICENSE}{\texttt{ }} \href{https://github.com/AnonymusRaccoon/ComSquare/issues}{\texttt{ }} \href{https://github.com/AnonymusRaccoon/ComSquare/actions?query=workflow\%3A\%22Build+commit+artifact\%22}{\texttt{ }} \href{https://github.com/AnonymusRaccoon/ComSquare/actions?query=workflow\%3A\%22Testing+current+commit\%22}{\texttt{ }} \href{https://codecov.io/gh/AnonymusRaccoon/ComSquare}{\texttt{ }}
Com² is a S\+N\+ES emulator for Linux built in C++ by 3 friends.
\DoxyHorRuler{0}
\hypertarget{md_README_autotoc_md0}{}\doxysubsection{Installation}\label{md_README_autotoc_md0}
You can use an artifact from latest commit by selecting ✔️ and {\ttfamily 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 \+: {\ttfamily git clone \href{https://github.com/AnonymusRaccoon/ComSquare.git}{\texttt{ https\+://github.\+com/\+Anonymus\+Raccoon/\+Com\+Square.\+git}}}
You need the \href{https://www.sfml-dev.org/download.php}{\texttt{ S\+F\+ML library}}.
After going inside the repository directory, create a build folder {\ttfamily mkdir build}, go inside and make {\ttfamily cmake ..} to finally make {\ttfamily make}. If you\textquotesingle{}ve done nothing wrong, you should have the program compiled!\hypertarget{md_README_autotoc_md1}{}\doxysubsection{Informations}\label{md_README_autotoc_md1}
During the development we will update and create documentations about the S\+N\+ES and the emulator, we will use \href{https://github.com/AnonymusRaccoon/ComSquare/projects}{\texttt{ Git\+Hub Projects}} page and \href{https://github.com/AnonymusRaccoon/ComSquare/wiki}{\texttt{ Git\+Hub Wiki}} to inform you about \char`\"{}everything\char`\"{}. The documentation can be found to \href{https://anonymusraccoon.github.io/ComSquare/}{\texttt{ Com\+Square Documentation}}\hypertarget{md_README_autotoc_md2}{}\doxysubsubsection{Licence}\label{md_README_autotoc_md2}
As seen on the badge, we use \href{./LICENSE}{\texttt{ G\+P\+Lv3 license}}, so you\textquotesingle{}re free to use, fork and modify our program freely, we are 100\% Open Source!