deploy: 5ed1406c81044ff73fd919b5aad184aaed0a174bgh-pages

1 files changed, 106 insertions, 0 deletions

diff --git a/index.html b/index.html
new file mode 100644
index 0000000..c3436fc
--- /dev/null
+++ b/index.html
@@ -0,0 +1,106 @@
+<!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" lang="en-US">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen 1.9.8"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Relational Algebra Engine: Relational Algebra Engine</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 id="projectrow">
+  <td id="projectalign">
+   <div id="projectname">Relational Algebra Engine
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.8 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<!-- 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">
+<div id="MSearchResults">
+<div class="SRPage">
+<div id="SRIndex">
+<div id="SRResults"></div>
+<div class="SRStatus" id="Loading">Loading...</div>
+<div class="SRStatus" id="Searching">Searching...</div>
+<div class="SRStatus" id="NoMatches">No Matches</div>
+</div>
+</div>
+</div>
+</div>
+
+<div><div class="header">
+  <div class="headertitle"><div class="title">Relational Algebra Engine </div></div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><p>The <b>Relational Algebra Engine</b> implements relational algebra in its strict, theoretical form, adhering rigorously to the principles of relational theory as articulated by E. F. Codd.</p>
+<p>A <b>relation</b> is modeled as a set of tuples, each tuple being a set of attributes. Each attribute is a pairing of a name with a value drawn from a domain. All operations are defined on <b>entire relations as sets</b>, with no recourse to the compromises typical of SQL or other practical implementations.</p>
+<p>The engine is intended as a <b>study in correctness</b>: each operation, from projection to join, is executed in a manner consistent with the classical definition of relational algebra. It is a platform for exploring the consequences of relational theory in a low-level programming context, providing both a tool for experimentation and a concrete realization of the abstract model.</p>
+<h1><a class="anchor" id="structure"></a>
+Project Structure</h1>
+<ul>
+<li><code>src/</code> — C source files implementing the engine</li>
+<li><code>include/</code> — Header files for public APIs</li>
+<li><code>docs/</code> — Documentation and images</li>
+<li><code>Makefile</code> — Build and formatting commands</li>
+<li><code>Doxyfile</code> — Doxygen configuration for code documentation</li>
+</ul>
+<p>To build the documentation locally: </p><div class="fragment"><div class="line">doxygen Doxyfile</div>
+</div><!-- fragment --><p>The HTML output will be in <code>docs/doxygen/html/</code>. GitHub Actions will auto-deploy docs from the <code>docs/doxygen/html</code> directory to the <code>gh-pages</code> branch.</p>
+<h1><a class="anchor" id="usage"></a>
+Usage</h1>
+<p>Compile and run the engine: </p><div class="fragment"><div class="line">make</div>
+</div><!-- fragment --><p>Format the source code: </p><div class="fragment"><div class="line">make format</div>
+</div><!-- fragment --><h1><a class="anchor" id="contributing"></a>
+Contributing</h1>
+<p>Pull requests and issues are welcome! Please format code with clang-format before submitting.</p>
+<h1><a class="anchor" id="license"></a>
+License</h1>
+<p>This project is licensed under the APACHE 2.0 License. See the LICENSE file for details. </p>
+</div></div><!-- PageDoc -->
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
+</small></address>
+</body>
+</html>