added documentation report template

main
ParkerTenBroeck 2025-04-09 11:56:31 -04:00
parent c31889efd9
commit 5c7ed130b3
5 changed files with 77 additions and 0 deletions

8
doc/.gitignore vendored Normal file
View File

@ -0,0 +1,8 @@
*.log
*.pdf
*.aux
*.bbl
*.blg
*.fdb_latexmk
*.fls
*.out

BIN
doc/doc.synctex.gz Normal file

Binary file not shown.

55
doc/doc.tex Normal file
View File

@ -0,0 +1,55 @@
\documentclass[conference]{IEEEtran}
\IEEEoverridecommandlockouts
\usepackage[pdftex,pdfpagelabels,bookmarks,hyperindex,hyperfigures]{hyperref}
\usepackage{float}
\usepackage{adjustbox}
\usepackage[table]{xcolor}
\usepackage{cite}
\usepackage{tikz}
\usetikzlibrary{arrows.meta,
matrix,
positioning}
\usepackage{amsmath,amssymb,amsfonts}
\usepackage{algorithmic}
\usepackage{graphicx}
\usepackage{textcomp}
\usepackage{xcolor}
\def\BibTeX{{\rm B\kern-.05em{\sc i\kern-.025em b}\kern-.08em
T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX}}
% \usepackage[margin=0.25in]{geometry}
% \usepackage{geometry}
\usepackage{pgfplots}
\pgfplotsset{compat=1.9}
% \pgfplotsset{width=7cm,height=5cm,compat=newest}
\begin{document}
\title{4P78 Project Documentation\\}
\author{
\IEEEauthorblockN{Parker TenBroeck 7376726}
pt21zs@brocku.ca
\and
\IEEEauthorblockN{Brett}
brett@brocku.ca
}
\maketitle
\section{Introduction}
meow
\section{Instructions}
\section{Problem Set}
\section{Approaches}
\section{Challanages}
\section{External Tools}
\nocite{*}
\bibliographystyle{IEEEtran}
\bibliography{references}
\end{document}

1
doc/make_report.sh Executable file
View File

@ -0,0 +1 @@
latexmk -pdf doc.tex

13
doc/references.bib Normal file
View File

@ -0,0 +1,13 @@
@BOOK{texbook,
author = "Donald E. Knuth",
title= "The {{\TeX}book}",
publisher = "Addison-Wesley",
year = 1984
}
@BOOK{latexbook,
author = "Leslie Lamport",
title = "{\LaTeX \rm:} {A} Document Preparation System",
publisher = "Addison-Wesley",
year = 1986
}