Merge pull request #19 from VeryAmazed/dev

stuffs
VeryAmazed · Mar 25, 2024 · d57857b · d57857b
2 parents 3a6c8cb + cec75b2
commit d57857b
Show file tree

Hide file tree

Showing 16 changed files with 219 additions and 326 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -42,7 +42,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Brev"
+PROJECT_NAME           = "digest"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

diff --git a/README.md b/README.md
@@ -52,6 +52,14 @@ our general guidelines:
 adaptive performs at worst about 10% slower than best  
 adaptive64 performs at worst about 100% slower than best
 
+# Contributing
+run
+```bash
+ninja clang-format
+ninja clang-tidy
+ninja docs
+```
+
 # Benchmark / Tests
 ```bash
 meson setup build

diff --git a/docs/build.sh b/docs/build.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+if [ -z "${MESON_SOURCE_ROOT}" ]; then
+  echo "[ERROR] This script can only be ran with meson!"
+  exit 1
+fi
+
+set -euo pipefail
+
+cd "${MESON_SOURCE_ROOT}"
+doxygen
diff --git a/docs/html/index.html b/docs/html/index.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.10.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Brev: Main Page</title>
+<title>digest: Main Page</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>
@@ -23,7 +23,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Brev
+   <div id="projectname">digest
    </div>
   </td>
  </tr>
@@ -71,7 +71,7 @@
 </div>
 
 <div class="header">
-  <div class="headertitle"><div class="title">Brev Documentation</div></div>
+  <div class="headertitle"><div class="title">digest Documentation</div></div>
 </div><!--header-->
 <div class="contents">
 <a href="doxygen_crawl.html"/>

diff --git a/docs/html/md_README.html b/docs/html/md_README.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.10.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Brev: Digest</title>
+<title>digest: Digest</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>
@@ -23,7 +23,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Brev
+   <div id="projectname">digest
    </div>
   </td>
  </tr>
@@ -123,11 +123,15 @@ <h1><a class="anchor" id="autotoc_md5"></a>
 <p>adaptive performs at worst about 10% slower than best <br  />
  adaptive64 performs at worst about 100% slower than best</p>
 <h1><a class="anchor" id="autotoc_md6"></a>
+Contributing</h1>
+<p>run </p><div class="fragment"><div class="line">ninja clang-format</div>
+<div class="line">ninja clang-tidy</div>
+<div class="line">ninja docs</div>
+</div><!-- fragment --><h1><a class="anchor" id="autotoc_md7"></a>
 Benchmark / Tests</h1>
 <div class="fragment"><div class="line">meson setup build</div>
 <div class="line">cd build &amp;&amp; meson compile</div>
-</div><!-- fragment --><p> this will generate proper executables for benchmark/testing</p>
-<p>fix digester array </p>
+</div><!-- fragment --><p> this will generate proper executables for benchmark/testing </p>
 </div></div><!-- contents -->
 </div><!-- PageDoc -->
 <!-- start footer part -->

diff --git a/docs/html/pages.html b/docs/html/pages.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.10.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Brev: Related Pages</title>
+<title>digest: Related Pages</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>
@@ -23,7 +23,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Brev
+   <div id="projectname">digest
    </div>
   </td>
  </tr>

diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['benchmark_20tests_0',['Benchmark / Tests',['../md_README.html#autotoc_md6',1,'']]]
+  ['benchmark_20tests_0',['Benchmark / Tests',['../md_README.html#autotoc_md7',1,'']]]
 ];
diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js
@@ -1,5 +1,6 @@
 var searchData=
 [
   ['code_0',['Implementation (Most of the documentation is in the code)',['../md_README.html#autotoc_md1',1,'']]],
-  ['correct_20tt_20data_5fstructure_20tt_1',['Selecting the correct &lt;tt&gt;data_structure&lt;/tt&gt;',['../md_README.html#autotoc_md5',1,'']]]
+  ['contributing_1',['Contributing',['../md_README.html#autotoc_md6',1,'']]],
+  ['correct_20tt_20data_5fstructure_20tt_2',['Selecting the correct &lt;tt&gt;data_structure&lt;/tt&gt;',['../md_README.html#autotoc_md5',1,'']]]
 ];
diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js
@@ -1,6 +1,6 @@
 var searchData=
 [
-  ['tests_0',['Benchmark / Tests',['../md_README.html#autotoc_md6',1,'']]],
+  ['tests_0',['Benchmark / Tests',['../md_README.html#autotoc_md7',1,'']]],
   ['the_20correct_20tt_20data_5fstructure_20tt_1',['Selecting the correct &lt;tt&gt;data_structure&lt;/tt&gt;',['../md_README.html#autotoc_md5',1,'']]],
   ['the_20documentation_20is_20in_20the_20code_2',['Implementation (Most of the documentation is in the code)',['../md_README.html#autotoc_md1',1,'']]],
   ['tt_20data_5fstructure_20tt_3',['Selecting the correct &lt;tt&gt;data_structure&lt;/tt&gt;',['../md_README.html#autotoc_md5',1,'']]]

diff --git a/docs/latex/md_README.tex b/docs/latex/md_README.tex
@@ -57,13 +57,19 @@ \chapter{Digest}
 \end{DoxyItemize}
 
 adaptive performs at worst about 10\% slower than best ~\newline
- adaptive64 performs at worst about 100\% slower than best\hypertarget{md_README_autotoc_md6}{}\doxysection{\texorpdfstring{Benchmark / Tests}{Benchmark / Tests}}\label{md_README_autotoc_md6}
+ adaptive64 performs at worst about 100\% slower than best\hypertarget{md_README_autotoc_md6}{}\doxysection{\texorpdfstring{Contributing}{Contributing}}\label{md_README_autotoc_md6}
+run 
+\begin{DoxyCode}{0}
+\DoxyCodeLine{ninja\ clang-\/format}
+\DoxyCodeLine{ninja\ clang-\/tidy}
+\DoxyCodeLine{ninja\ docs}
+
+\end{DoxyCode}
+\hypertarget{md_README_autotoc_md7}{}\doxysection{\texorpdfstring{Benchmark / Tests}{Benchmark / Tests}}\label{md_README_autotoc_md7}
 
 \begin{DoxyCode}{0}
 \DoxyCodeLine{meson\ setup\ build}
 \DoxyCodeLine{cd\ build\ \&\&\ meson\ compile}
 
 \end{DoxyCode}
- this will generate proper executables for benchmark/testing
-
-fix digester array 
+ this will generate proper executables for benchmark/testing 
diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex
@@ -156,7 +156,7 @@
       linkcolor=blue,%
       citecolor=blue,%
       unicode,%
-      pdftitle={Brev},%
+      pdftitle={digest},%
       pdfsubject={}%
     }
   % Custom commands used by the header
@@ -193,7 +193,7 @@
   \begin{titlepage}
   \vspace*{7cm}
   \begin{center}%
-  {\Large Brev}\\
+  {\Large digest}\\
   \vspace*{1cm}
   {\large Generated by Doxygen 1.10.0}\\
   \end{center}