Skip to content

Commit

Permalink
Merge pull request #36 from arbCoding/devel
Browse files Browse the repository at this point in the history
Documentation update.
  • Loading branch information
arbCoding authored Jan 27, 2024
2 parents 8c8d4b2 + 11873f3 commit fd3944d
Show file tree
Hide file tree
Showing 13 changed files with 45 additions and 27 deletions.
6 changes: 3 additions & 3 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
#+exclude_tags: noexport
#+creator: Emacs 29.1 (Org mode 9.7)

[[https://github.com/arbCoding/sac-format/actions/workflows/cmake-windows.yml][https://github.com/arbCoding/sac-format/actions/workflows/cmake-windows.yml/badge.svg]]
[[https://github.com/arbCoding/sac-format/actions/workflows/cmake-ubuntu.yml][https://github.com/arbCoding/sac-format/actions/workflows/cmake-ubuntu.yml/badge.svg]]
[[https://github.com/arbCoding/sac-format/actions/workflows/cmake-macos.yml][https://github.com/arbCoding/sac-format/actions/workflows/cmake-macos.yml/badge.svg]]
[[https://github.com/arbCoding/sac-format/actions/workflows/cmake-windows.yml][https://github.com/arbCoding/sac-format/actions/workflows/cmake-windows-package.yml/badge.svg]]
[[https://github.com/arbCoding/sac-format/actions/workflows/cmake-ubuntu.yml][https://github.com/arbCoding/sac-format/actions/workflows/cmake-ubuntu-package.yml/badge.svg]]
[[https://github.com/arbCoding/sac-format/actions/workflows/cmake-macos.yml][https://github.com/arbCoding/sac-format/actions/workflows/cmake-macos-package.yml/badge.svg]]
[[https://app.codecov.io/gh/arbCoding/sac-format][https://codecov.io/gh/arbCoding/sac-format/graph/badge.svg]]
# Tokei_rs has been down for weeks now:<2023-12-07 Thu>
# @@html:<img alt="Lines of code" src="https://tokei.rs/b1/github/arbCoding/sac-format?category=code">@@
Expand Down
2 changes: 1 addition & 1 deletion docs/BasicDocumentation.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/BuildInstructions.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!doctype html><html xmlns=http://www.w3.org/1999/xhtml lang=en-US><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>sac-format: Build Instructions</title>
<link href=tabs.css rel=stylesheet><script src=jquery.js></script><script src=dynsections.js></script><link href=navtree.css rel=stylesheet><script src=resize.js></script><script src=navtreedata.js></script><script src=navtree.js></script><link href=search/search.css rel=stylesheet><script src=search/searchdata.js></script><script src=search/search.js></script><link href=doxygen.css rel=stylesheet><link href=doxygen-awesome.css rel=stylesheet><div id=top><div id=titlearea><table cellspacing=0 cellpadding=0><tbody><tr id=projectrow><td id=projectalign><div id=projectname>sac-format<span id=projectnumber>&#160;0.6.0</span></div><div id=projectbrief>C++20 SAC (Seismic Analysis Code) File Library</div></table></div><script>var searchBox=new SearchBox("searchBox","search/",".html")</script><script src=menudata.js></script><script src=menu.js></script><script>$(function(){initMenu("",!0,!1,"search.php","Search"),$(document).ready(function(){init_search()})})</script><div id=main-nav></div></div><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>$(document).ready(function(){initNavTree("BuildInstructions.html",""),initResizable()})</script><div id=doc-content><div id=MSearchSelectWindow onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"></div><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>Build Instructions</div></div></div><div class=contents><div class=textblock><h1><a class=anchor id=autotoc_md167></a>Dependencies</h1><h2><a class=anchor id=autotoc_md168></a>Automatic (CMake)</h2><p><a href=https://github.com/Reputeless/Xoshiro-cpp>Xoshiro-cpp v1.12.0</a> (testing and benchmarking)<h2><a class=anchor id=autotoc_md169></a>Manual</h2><p><a href=https://github.com/catchorg/Catch2>Catch2 v3.4.0</a> (testing and benchmarking)<h1><a class=anchor id=autotoc_md170></a>Building</h1><p>Building is as easy as cloning the repository, running CMake for your preferred build tool, and then building.<h2><a class=anchor id=autotoc_md171></a>GCC</h2><div class=fragment><div class=line>git clone https://github.com/arbCoding/sac-format.git</div><div class=line>cmake --preset gcc-hard-release</div><div class=line>cmake --build ./build/release/gcc</div></div><h2><a class=anchor id=autotoc_md172></a>Clang</h2><div class=fragment><div class=line>git clone https://github.com/arbCoding/sac-format.git</div><div class=line>cmake --preset clang-hard-release</div><div class=line>cmake --build ./build/release/clang</div></div></div></div></div></div><div id=nav-path class=navpath><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.8</ul></div>
<link href=tabs.css rel=stylesheet><script src=jquery.js></script><script src=dynsections.js></script><link href=navtree.css rel=stylesheet><script src=resize.js></script><script src=navtreedata.js></script><script src=navtree.js></script><link href=search/search.css rel=stylesheet><script src=search/searchdata.js></script><script src=search/search.js></script><link href=doxygen.css rel=stylesheet><link href=doxygen-awesome.css rel=stylesheet><div id=top><div id=titlearea><table cellspacing=0 cellpadding=0><tbody><tr id=projectrow><td id=projectalign><div id=projectname>sac-format<span id=projectnumber>&#160;0.6.0</span></div><div id=projectbrief>C++20 SAC (Seismic Analysis Code) File Library</div></table></div><script>var searchBox=new SearchBox("searchBox","search/",".html")</script><script src=menudata.js></script><script src=menu.js></script><script>$(function(){initMenu("",!0,!1,"search.php","Search"),$(document).ready(function(){init_search()})})</script><div id=main-nav></div></div><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>$(document).ready(function(){initNavTree("BuildInstructions.html",""),initResizable()})</script><div id=doc-content><div id=MSearchSelectWindow onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"></div><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>Build Instructions</div></div></div><div class=contents><div class=textblock><h1><a class=anchor id=autotoc_md167></a>Dependencies</h1><h2><a class=anchor id=autotoc_md168></a>Automatic (CMake)</h2><p><a href=https://github.com/Reputeless/Xoshiro-cpp>Xoshiro-cpp v1.12.0</a> (testing and benchmarking).<h2><a class=anchor id=autotoc_md169></a>Manual</h2><p><a href=https://github.com/catchorg/Catch2>Catch2 v3.4.0</a> (testing and benchmarking). Note that this is automatic on Windows (not Linux nor macOS).<h1><a class=anchor id=autotoc_md170></a>Building</h1><p>Building is as easy as cloning the repository, running CMake for your preferred build tool, and then building.<h2><a class=anchor id=autotoc_md171></a>GCC</h2><div class=fragment><div class=line>git clone https://github.com/arbCoding/sac-format.git</div><div class=line>cmake --preset gcc-hard-release</div><div class=line>cmake --build ./build/release/gcc</div></div><h2><a class=anchor id=autotoc_md172></a>Clang</h2><div class=fragment><div class=line>git clone https://github.com/arbCoding/sac-format.git</div><div class=line>cmake --preset clang-hard-release</div><div class=line>cmake --build ./build/release/clang</div></div></div></div></div></div><div id=nav-path class=navpath><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.8</ul></div>
Loading

0 comments on commit fd3944d

Please sign in to comment.