The program called "doxygen" (GitHub Page and Website) is what we're using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we've done.
It simply uses a small configuration file at the root of the project /Doxyfile to store some settings, and the rest is through mainly Markdown files (.md or .markdown) and source code files.
It is setup (as of writing this) that someone can simply open the /Doxyfile in the GUI Wizard, click on the "Run" tab, then "Run doxygen", and everything will be updated... that's it.
-
+
Updating Documentation
You need to have installed the program from either the GitHub page or website, then simply open the /Doxyfile within the GUI frontend or "Wizard".
-
+
Important Notes
Make sure that the /Doxyfile stays where it's at! It should be kept at the root directory (just to keep things simple)
Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the /Doxyfile, they'll have to re-do all of them in order for it to start functioning again.
DO NOT put any files into the /Documentation folder manually, as they WILL BE DELETED when doxygen is run.
-
+
For Consistency
Please make sure the internal names ("tags") of files are using "camelCase"
@@ -114,7 +121,7 @@ For Consistency
-
Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by 1.9.1
+
Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by 1.9.1
For Documentation, we will use "doxygen" to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.
Generated on Tue Feb 2 2021 00:44:35 for 2020-2021 Sunseeker Telemetry and Lighting System by 1.9.1
+
Generated on Wed Feb 3 2021 17:04:16 for 2020-2021 Sunseeker Telemetry and Lighting System by 1.9.1
diff --git a/Documentation/html/splitbar.png b/Documentation/html/splitbar.png
index 26e90ae..b5686ed 100644
Binary files a/Documentation/html/splitbar.png and b/Documentation/html/splitbar.png differ
diff --git a/Documentation/html/sync_off.png b/Documentation/html/sync_off.png
index c60db30..a0117a6 100644
Binary files a/Documentation/html/sync_off.png and b/Documentation/html/sync_off.png differ
diff --git a/Documentation/html/sync_on.png b/Documentation/html/sync_on.png
index 985e435..3cacd28 100644
Binary files a/Documentation/html/sync_on.png and b/Documentation/html/sync_on.png differ
diff --git a/Documentation/html/tab_a.png b/Documentation/html/tab_a.png
index adc118d..1174805 100644
Binary files a/Documentation/html/tab_a.png and b/Documentation/html/tab_a.png differ
diff --git a/Documentation/html/tab_b.png b/Documentation/html/tab_b.png
index 126daff..812eb72 100644
Binary files a/Documentation/html/tab_b.png and b/Documentation/html/tab_b.png differ
diff --git a/Documentation/html/tab_h.png b/Documentation/html/tab_h.png
index a1d85fe..e84e4db 100644
Binary files a/Documentation/html/tab_h.png and b/Documentation/html/tab_h.png differ
diff --git a/Documentation/html/tab_s.png b/Documentation/html/tab_s.png
index 43e1893..c3bc84b 100644
Binary files a/Documentation/html/tab_s.png and b/Documentation/html/tab_s.png differ
diff --git a/Documentation/latex/documentation_guide.tex b/Documentation/latex/documentation_guide.tex
index 3092c29..948b6c1 100644
--- a/Documentation/latex/documentation_guide.tex
+++ b/Documentation/latex/documentation_guide.tex
@@ -1,16 +1,16 @@
-\hypertarget{documentation_guide_autotoc_md20}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md20}
+\hypertarget{documentation_guide_autotoc_md19}{}\doxysection{Doxygen}\label{documentation_guide_autotoc_md19}
The program called \char`\"{}doxygen\char`\"{} (\href{https://github.com/doxygen/doxygen}{\texttt{ Git\+Hub Page}} and \href{https://www.doxygen.nl/}{\texttt{ Website}}) is what we\textquotesingle{}re using to document our project and try to make things a bit simpler/easier not only for us, but also future projects or people looking at what we\textquotesingle{}ve done.
It simply uses a small configuration file at the root of the project {\ttfamily /\+Doxyfile} to store some settings, and the rest is through mainly Markdown files ({\ttfamily .md} or {\ttfamily .markdown}) and source code files.
-It is setup (as of writing this) that someone can simply open the {\ttfamily /\+Doxyfile} in the GUI Wizard, click on the \char`\"{}\+Run\char`\"{} tab, then \char`\"{}\+Run doxygen\char`\"{}, and everything will be updated... that\textquotesingle{}s it.\hypertarget{documentation_guide_autotoc_md21}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md21}
-You need to have installed the program from either the Git\+Hub page or website, then simply open the {\ttfamily /\+Doxyfile} within the GUI frontend or \char`\"{}\+Wizard\char`\"{}.\hypertarget{documentation_guide_autotoc_md22}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md22}
+It is setup (as of writing this) that someone can simply open the {\ttfamily /\+Doxyfile} in the GUI Wizard, click on the \char`\"{}\+Run\char`\"{} tab, then \char`\"{}\+Run doxygen\char`\"{}, and everything will be updated... that\textquotesingle{}s it.\hypertarget{documentation_guide_autotoc_md20}{}\doxysection{Updating Documentation}\label{documentation_guide_autotoc_md20}
+You need to have installed the program from either the Git\+Hub page or website, then simply open the {\ttfamily /\+Doxyfile} within the GUI frontend or \char`\"{}\+Wizard\char`\"{}.\hypertarget{documentation_guide_autotoc_md21}{}\doxysection{Important Notes}\label{documentation_guide_autotoc_md21}
\begin{DoxyItemize}
\item Make sure that the {\ttfamily /\+Doxyfile} stays where it\textquotesingle{}s at! It should be kept at the root directory (just to keep things simple)
\item Make sure you use RELATIVE paths when changing configurations, or else when someone else tries running the {\ttfamily /\+Doxyfile}, they\textquotesingle{}ll have to re-\/do all of them in order for it to start functioning again.
\item {\bfseries{DO NOT}} put any files into the {\ttfamily /\+Documentation} folder manually, as they {\bfseries{WILL BE DELETED}} when doxygen is run.
-\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md23}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md23}
+\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md22}{}\doxysubsection{For Consistency}\label{documentation_guide_autotoc_md22}
\begin{DoxyItemize}
\item Please make sure the internal names (\char`\"{}tags\char`\"{}) of files are using \char`\"{}camel\+Case\char`\"{}
diff --git a/Documentation/latex/index.tex b/Documentation/latex/index.tex
index 1528abe..a69da1a 100644
--- a/Documentation/latex/index.tex
+++ b/Documentation/latex/index.tex
@@ -1,17 +1,8 @@
-{\bfseries{Subpages}}
-
-
-\begin{DoxyItemize}
-\item \mbox{\hyperlink{hardware}{Hardware}}
-\item \mbox{\hyperlink{software}{Software}}
-\end{DoxyItemize}
-
-\DoxyHorRuler{0}
-\hypertarget{index_autotoc_md15}{}\doxysection{About}\label{index_autotoc_md15}
-What this project is about (TODO)\hypertarget{index_autotoc_md16}{}\doxysection{Documentation}\label{index_autotoc_md16}
+\hypertarget{index_autotoc_md14}{}\doxysection{About}\label{index_autotoc_md14}
+What this project is about (TODO)\hypertarget{index_autotoc_md15}{}\doxysection{Documentation}\label{index_autotoc_md15}
For Documentation, we will use \char`\"{}doxygen\char`\"{} to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.
-More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Guide}}\hypertarget{index_autotoc_md17}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md17}
+More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Guide}}\hypertarget{index_autotoc_md16}{}\doxysubsection{Tips from Dr. Bazuin}\label{index_autotoc_md16}
\begin{DoxyItemize}
\item Make sub-\/circuits/sub-\/designs for schematics to keep things organized and modular/copy-\/able
@@ -28,13 +19,15 @@ More information here\+: \mbox{\hyperlink{documentation_guide}{Documentation Gui
\item Document things as we go
\item Need to make sure we have a BOM
\item Free samples for parts from manufacturers
-\end{DoxyItemize}\hypertarget{index_autotoc_md18}{}\doxysubsection{Tips from Dr. Gomez}\label{index_autotoc_md18}
+\item Make peripherals like output on one side and inputs on the other
+\item Use SPI Chip Select as a separate command (Use 3-\/pin SPI and then just use GPIO for Chip Select)
+\end{DoxyItemize}\hypertarget{index_autotoc_md17}{}\doxysubsection{Tips from Dr. Gomez}\label{index_autotoc_md17}
\begin{DoxyItemize}
\item Our requirements/specifications should be made to be more measurable
\item Need to design to safety standards, which need to be researched online
\item He said that he is available himself for anything power-\/related to help out with if needed
-\end{DoxyItemize}\hypertarget{index_autotoc_md19}{}\doxysection{TODO List}\label{index_autotoc_md19}
+\end{DoxyItemize}\hypertarget{index_autotoc_md18}{}\doxysection{TODO List}\label{index_autotoc_md18}
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Make battery circuitry for Real-\/\+Time Clock/\+Calendar for when the vehicle is off.
diff --git a/Documentation/latex/refman.tex b/Documentation/latex/refman.tex
index 5c0e916..4e16df1 100644
--- a/Documentation/latex/refman.tex
+++ b/Documentation/latex/refman.tex
@@ -171,7 +171,7 @@
\hypersetup{pageanchor=true}
%--- Begin generated contents ---
-\chapter{Main Page}
+\chapter{Home}
\label{index}\hypertarget{index}{}\input{index}
\chapter{Hardware}
\label{hardware}
diff --git a/Doxyfile.doxygen b/Doxyfile.doxygen
index 1bba4ce..9cfc94f 100644
--- a/Doxyfile.doxygen
+++ b/Doxyfile.doxygen
@@ -1097,13 +1097,13 @@ STRIP_CODE_COMMENTS = YES
# entity all documented functions referencing it will be listed.
# The default value is: NO.
-REFERENCED_BY_RELATION = NO
+REFERENCED_BY_RELATION = YES
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
-REFERENCES_RELATION = NO
+REFERENCES_RELATION = YES
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
@@ -1308,7 +1308,7 @@ HTML_EXTRA_FILES =
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_COLORSTYLE_HUE = 213
+HTML_COLORSTYLE_HUE = 216
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
@@ -1316,7 +1316,7 @@ HTML_COLORSTYLE_HUE = 213
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_COLORSTYLE_SAT = 156
+HTML_COLORSTYLE_SAT = 135
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
@@ -1327,7 +1327,7 @@ HTML_COLORSTYLE_SAT = 156
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_COLORSTYLE_GAMMA = 73
+HTML_COLORSTYLE_GAMMA = 82
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
@@ -1355,7 +1355,7 @@ HTML_DYNAMIC_MENUS = YES
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_DYNAMIC_SECTIONS = NO
+HTML_DYNAMIC_SECTIONS = YES
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
@@ -1658,7 +1658,7 @@ FORMULA_MACROFILE =
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
-USE_MATHJAX = NO
+USE_MATHJAX = YES
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
diff --git a/README.markdown b/README.markdown
index e52e8e8..52f50de 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,14 +1,4 @@
-@mainpage
-
-@b Subpages
-
-- @subpage hardware
-
-- @subpage software
-
----
-
-
+@mainpage Home
# About
1.9.1
+