Skip to content

Commit

Permalink
deploy: f92c9ff
Browse files Browse the repository at this point in the history
  • Loading branch information
@Dolfost
Dolfost committed Aug 24, 2024
0 parents commit ea32c24
Show file tree
Hide file tree
Showing 695 changed files with 59,897 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
142 changes: 142 additions & 0 deletions annotated.html

Large diffs are not rendered by default.

38 changes: 38 additions & 0 deletions annotated_dup.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
var annotated_dup =
[
[ "tt", "namespacett.html", [
[ "chess", "namespacett_1_1chess.html", [
[ "ex", "namespacett_1_1chess_1_1ex.html", [
[ "duplicate_king", "classtt_1_1chess_1_1ex_1_1duplicate__king.html", "classtt_1_1chess_1_1ex_1_1duplicate__king" ],
[ "no_king", "classtt_1_1chess_1_1ex_1_1no__king.html", "classtt_1_1chess_1_1ex_1_1no__king" ],
[ "check", "classtt_1_1chess_1_1ex_1_1check.html", "classtt_1_1chess_1_1ex_1_1check" ],
[ "checkmate", "classtt_1_1chess_1_1ex_1_1checkmate.html", "classtt_1_1chess_1_1ex_1_1checkmate" ]
] ],
[ "Chessboard", "classtt_1_1chess_1_1Chessboard.html", "classtt_1_1chess_1_1Chessboard" ],
[ "Pawn", "classtt_1_1chess_1_1Pawn.html", "classtt_1_1chess_1_1Pawn" ],
[ "Knight", "classtt_1_1chess_1_1Knight.html", "classtt_1_1chess_1_1Knight" ],
[ "Bishop", "classtt_1_1chess_1_1Bishop.html", "classtt_1_1chess_1_1Bishop" ],
[ "Rook", "classtt_1_1chess_1_1Rook.html", "classtt_1_1chess_1_1Rook" ],
[ "Queen", "classtt_1_1chess_1_1Queen.html", "classtt_1_1chess_1_1Queen" ],
[ "King", "classtt_1_1chess_1_1King.html", "classtt_1_1chess_1_1King" ]
] ],
[ "ex", "namespacett_1_1ex.html", [
[ "tartan", "classtt_1_1ex_1_1tartan.html", "classtt_1_1ex_1_1tartan" ],
[ "bad_set", "classtt_1_1ex_1_1bad__set.html", "classtt_1_1ex_1_1bad__set" ],
[ "bad_piece", "classtt_1_1ex_1_1bad__piece.html", "classtt_1_1ex_1_1bad__piece" ],
[ "null_piece", "classtt_1_1ex_1_1null__piece.html", "classtt_1_1ex_1_1null__piece" ],
[ "foreign_piece", "classtt_1_1ex_1_1foreign__piece.html", "classtt_1_1ex_1_1foreign__piece" ],
[ "bad_piece_spec", "classtt_1_1ex_1_1bad__piece__spec.html", "classtt_1_1ex_1_1bad__piece__spec" ],
[ "position_is_taken", "classtt_1_1ex_1_1position__is__taken.html", "classtt_1_1ex_1_1position__is__taken" ],
[ "illegal_move", "classtt_1_1ex_1_1illegal__move.html", "classtt_1_1ex_1_1illegal__move" ],
[ "tile_is_empty", "classtt_1_1ex_1_1tile__is__empty.html", "classtt_1_1ex_1_1tile__is__empty" ],
[ "piece_in_wrong_color", "classtt_1_1ex_1_1piece__in__wrong__color.html", "classtt_1_1ex_1_1piece__in__wrong__color" ],
[ "can_not_move", "classtt_1_1ex_1_1can__not__move.html", "classtt_1_1ex_1_1can__not__move" ],
[ "no_such_move", "classtt_1_1ex_1_1no__such__move.html", "classtt_1_1ex_1_1no__such__move" ],
[ "illegal_turn", "classtt_1_1ex_1_1illegal__turn.html", "classtt_1_1ex_1_1illegal__turn" ],
[ "bad_piece_type", "classtt_1_1ex_1_1bad__piece__type.html", "classtt_1_1ex_1_1bad__piece__type" ]
] ],
[ "Piece", "classtt_1_1Piece.html", "classtt_1_1Piece" ],
[ "Board", "classtt_1_1Board.html", "classtt_1_1Board" ]
] ]
];
Binary file added bc_s.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added bdwn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
441 changes: 441 additions & 0 deletions board_2board_8hpp_source.html

Large diffs are not rendered by default.

278 changes: 278 additions & 0 deletions board_2include_2tartan_2board_2exceptions_8hpp_source.html

Large diffs are not rendered by default.

100 changes: 100 additions & 0 deletions board_8hpp_source.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tartan: board/include/tartan/board.hpp Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">tartan
&#160;<span id="projectnumber">1.2.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('board_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">board.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#include &quot;board/board.hpp&quot;</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_8ce7cd6e96eb11a61d1d013aa8c7fa46.html">board</a></li><li class="navelem"><a class="el" href="dir_d0dc48bc3eb7806d335d9d6a6c61931e.html">include</a></li><li class="navelem"><a class="el" href="dir_b1b70d624a8ea63110426bf73ac60e3b.html">tartan</a></li><li class="navelem"><b>board.hpp</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
160 changes: 160 additions & 0 deletions building.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tartan: Building</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">tartan
&#160;<span id="projectnumber">1.2.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('building.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Building </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Project have to be configured with <code>cmake</code> <a class="el" href="citelist.html#CITEREF_cmake">[1]</a> utillity. Install it on you'r system.</p>
<h1><a class="anchor" id="demobuild"></a>
Demo build</h1>
<p>To build and run the demo of chess game (without documentation), you can: </p><div class="fragment"><div class="line">git clone https:<span class="comment">//github.com/Dolfost/tartan</span></div>
<div class="line">cd tartan</div>
<div class="line">mkdir build </div>
<div class="line">cd build </div>
<div class="line">cmake -B . -S .. -DTARTAN_DOCS=NO</div>
<div class="line">cmake --build . -t iplay</div>
</div><!-- fragment --><h1><a class="anchor" id="detailedbuild"></a>
Detailed build</h1>
<h4><a class="anchor" id="dbsources"></a>
Getting the sources</h4>
<p>To get the repo from github, you can execute the </p><div class="fragment"><div class="line">git clone https:<span class="comment">//github.com/Dolfost/tartan</span></div>
</div><!-- fragment --><p> To get ready for configuring step, execute next: </p><div class="fragment"><div class="line">cd tartan</div>
<div class="line">mkdir build </div>
<div class="line">cd build </div>
</div><!-- fragment --> <h4><a class="anchor" id="dbconfig"></a>
Build system configuration</h4>
<p>Configuring has a bit of flexibility. You can use next cmake defines during configuration:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Option </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadRight">Fallback variabble </th><th class="markdownTableHeadNone">Meaning </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><code>TARTAN_DOCS</code> </td><td class="markdownTableBodyCenter">bool </td><td class="markdownTableBodyRight">PROJECT_IS_TOP_LEVEL </td><td class="markdownTableBodyNone">Find <code>doxygen</code> and tools for docs generation </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><code>TARTAN_TESTING</code> </td><td class="markdownTableBodyCenter">bool </td><td class="markdownTableBodyRight">PROJECT_IS_TOP_LEVEL </td><td class="markdownTableBodyNone">Enable testing and build test executables </td></tr>
</table>
<p>Fallback varriable value is used when the corresponding Option is not defined.</p>
<p>To configure a project, do the: </p><div class="fragment"><div class="line">cmake -B . -S .. </div>
</div><!-- fragment --><p> from the <code>tartan/build</code> directory. To configure project to not build tests and documentation: </p><div class="fragment"><div class="line">cmake -B . -S .. -DTARTAN_TESTING=NO -DTARTAN_DOCS=NO</div>
</div><!-- fragment --><h4><a class="anchor" id="dbbuild"></a>
Building</h4>
<p>To produce executables, you have to execute: </p><div class="fragment"><div class="line">cmake --build .</div>
</div><!-- fragment --><p> That command will build all targets (that have not been disabled by <a class="el" href="building.html#dbconfig">Build system configuration</a> options)</p>
<p>Avaliable targets: </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Target name </th><th class="markdownTableHeadCenter">Explanation </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">tt_board </td><td class="markdownTableBodyCenter">Board class and it's perefirals. (<code>tartan/board/</code>) </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">tt_chess </td><td class="markdownTableBodyCenter">Chessboard class and it's perefirals (<code>tartan/chess/</code>) </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">doc </td><td class="markdownTableBodyCenter">Documentation </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">iplay </td><td class="markdownTableBodyCenter">Interactive textual chess game implementation </td></tr>
</table>
<p>For example, to build <code>iplay</code> target, you can </p><div class="fragment"><div class="line">cmake --biuld . -t iplay</div>
</div><!-- fragment --><p> in the <code>tartan/build</code> directory.</p>
<h4><a class="anchor" id="dbtest"></a>
Testing</h4>
<p>To test the produced executables, run the <code>ctest</code> tool in the <code>build</code> directory. </p><div class="fragment"><div class="line">ctest </div>
</div><!-- fragment --><p> Note that no test will be avaliable when the <code>TARTAN_TESTING</code> is set to false.</p>
<h2><a class="anchor" id="buildres"></a>
Results</h2>
<p>The <code>tartan/build/</code> directory will contain next folders (if You have not disabled some components with options at <a class="el" href="building.html#dbconfig">Build system configuration</a>):</p><ul>
<li><code>doc</code> Documentation of library. You can open html documentation by opening <code>tartan/build/doc/html/index.html</code> in your browser.</li>
<li><code>board</code> Base board and piece API classes library (<a class="el" href="classtt_1_1Board.html" title="8x8 game board">tt::Board</a>, <a class="el" href="classtt_1_1Piece.html" title="Generic board memeber piece API.">tt::Piece</a>)</li>
<li><code>chess</code> Chess game implemented (<a class="el" href="namespacett_1_1chess.html" title="Chess game namespace.">tt::chess</a>)</li>
<li><code>tests</code> Test executables. The <code>tests/interactivePlay</code> is a example chess implementation </li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit ea32c24

Please sign in to comment.