Skip to content

Commit

Permalink
Update documentation on 09fb599
Browse files Browse the repository at this point in the history
  • Loading branch information
Pagghiu committed Jan 27, 2024
1 parent 5a19fa1 commit f5050a4
Show file tree
Hide file tree
Showing 34 changed files with 953 additions and 936 deletions.
14 changes: 7 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,13 @@
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#autotoc_md45">Motivation</a></li>
<li class="level1"><a href="#autotoc_md46">Status</a></li>
<li class="level1"><a href="#autotoc_md47">Platforms</a></li>
<ul><li class="level1"><a href="#autotoc_md47">Motivation</a></li>
<li class="level1"><a href="#autotoc_md48">Status</a></li>
<li class="level1"><a href="#autotoc_md49">Platforms</a></li>
</ul>
</div>
<div class="textblock"><p ><a class="anchor" id="md_Index"></a></p>
<p ><b>Sane C++</b> is a set of C++ platform abstraction libraries for macOS, Windows and Linux (<a href="#autotoc_md47">Platforms</a>). <br />
<p ><b>Sane C++</b> is a set of C++ platform abstraction libraries for macOS, Windows and Linux. (<a href="#autotoc_md49">Platforms</a>). <br />
</p>
<p >Project <a class="el" href="page_principles.html">Principles</a>:</p>
<p >✅ Fast compile times <br />
Expand All @@ -129,7 +129,7 @@
✅ Easy to integrate <br />
⛔️ No C++ Standard Library / Exceptions / RTTI <br />
⛔️ No third party dependencies (prefer OS API)</p>
<h1><a class="anchor" id="autotoc_md45"></a>
<h1><a class="anchor" id="autotoc_md47"></a>
Motivation</h1>
<ul>
<li>Having fun building from scratch a cohesive ecosystem of libraries sharing the same core principles</li>
Expand All @@ -139,7 +139,7 @@ <h1><a class="anchor" id="autotoc_md45"></a>
</ul>
<p >You can take a look at the <a href="https://pagghiu.github.io/site/blog/2023-12-23-SaneCppLibrariesRelease.html">introductory blog post</a> if you like.</p>
<p >I've also started a <a href="https://www.youtube.com/@Pagghiu">Youtube Channel</a> with some videos on the project.</p>
<h1><a class="anchor" id="autotoc_md46"></a>
<h1><a class="anchor" id="autotoc_md48"></a>
Status</h1>
<p >Many libraries are in draft state, while others are slightly more usable. <br />
Click on specific page each library to know about its status. <br />
Expand Down Expand Up @@ -200,7 +200,7 @@ <h1><a class="anchor" id="autotoc_md46"></a>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><a class="el" href="library_time.html">Time</a> </td><td class="markdownTableBodyLeft">🟨 Time handling (relative, absolute, high resolution) </td></tr>
</table>
<h1><a class="anchor" id="autotoc_md47"></a>
<h1><a class="anchor" id="autotoc_md49"></a>
Platforms</h1>
<p >Supported: <br />
✅ macOS (and iOS) <br />
Expand Down
400 changes: 200 additions & 200 deletions docs/libraries.js

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/libraries_extra.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
var libraries_extra =
[
[ "Reflection Auto", "library_reflection_auto.html", [
[ "Status", "library_reflection_auto.html#autotoc_md252", null ],
[ "Description", "library_reflection_auto.html#autotoc_md253", null ],
[ "Roadmap", "library_reflection_auto.html#autotoc_md254", null ]
[ "Status", "library_reflection_auto.html#autotoc_md254", null ],
[ "Description", "library_reflection_auto.html#autotoc_md255", null ],
[ "Roadmap", "library_reflection_auto.html#autotoc_md256", null ]
] ],
[ "Serialization Binary Type Erased", "library_serialization_binary_type_erased.html", [
[ "Features", "library_serialization_binary_type_erased.html#autotoc_md255", null ],
[ "Status", "library_serialization_binary_type_erased.html#autotoc_md256", null ],
[ "Description", "library_serialization_binary_type_erased.html#autotoc_md257", null ],
[ "Roadmap", "library_serialization_binary_type_erased.html#autotoc_md258", null ]
[ "Features", "library_serialization_binary_type_erased.html#autotoc_md257", null ],
[ "Status", "library_serialization_binary_type_erased.html#autotoc_md258", null ],
[ "Description", "library_serialization_binary_type_erased.html#autotoc_md259", null ],
[ "Roadmap", "library_serialization_binary_type_erased.html#autotoc_md260", null ]
] ]
];
16 changes: 8 additions & 8 deletions docs/library_algorithms.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,17 @@
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><ul><li class="level2"><a href="#autotoc_md48">Features</a></li>
<li class="level2"><a href="#autotoc_md49">Status</a></li>
<li class="level2"><a href="#autotoc_md50">Description</a></li>
<li class="level2"><a href="#autotoc_md51">Roadmap</a></li>
<ul><ul><li class="level2"><a href="#autotoc_md50">Features</a></li>
<li class="level2"><a href="#autotoc_md51">Status</a></li>
<li class="level2"><a href="#autotoc_md52">Description</a></li>
<li class="level2"><a href="#autotoc_md53">Roadmap</a></li>
</ul>
</ul>
</div>
<div class="textblock"><p >🟥 Placeholder library templated algorithms will be placed</p>
<p >Algorithms is a placeholder where templated algorithms will be added as needed over time. <br />
</p>
<h2><a class="anchor" id="autotoc_md48"></a>
<h2><a class="anchor" id="autotoc_md50"></a>
Features</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
Expand All @@ -136,14 +136,14 @@ <h2><a class="anchor" id="autotoc_md48"></a>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><a class="el" href="group__group__algorithms.html#gaa808d058e4dbd1db8fe0dada95fb7a21">Algorithms::removeIf</a> </td><td class="markdownTableBodyNone">Removes all items in the given range, satisfying the given predicate. </td></tr>
</table>
<h2><a class="anchor" id="autotoc_md49"></a>
<h2><a class="anchor" id="autotoc_md51"></a>
Status</h2>
<p >🟥 Draft <br />
We need <em>MOAR</em> algorithms.</p>
<h2><a class="anchor" id="autotoc_md50"></a>
<h2><a class="anchor" id="autotoc_md52"></a>
Description</h2>
<p >Currently the list of algorithms is very short because it only contains only what's needed by other libraries. They're probably not enough to deserve their own library but hopefully additional algorithms will be added in the future and it's better grouping them here rather than keeping them around inside other libraries.</p>
<h2><a class="anchor" id="autotoc_md51"></a>
<h2><a class="anchor" id="autotoc_md53"></a>
Roadmap</h2>
<p >🟨 MVP Features:</p><ul>
<li>Unique</li>
Expand Down
Loading

0 comments on commit f5050a4

Please sign in to comment.