From 5c7ed130b33290bb6f457f194495ea83cd87154e Mon Sep 17 00:00:00 2001 From: ParkerTenBroeck <51721964+ParkerTenBroeck@users.noreply.github.com> Date: Wed, 9 Apr 2025 11:56:31 -0400 Subject: [PATCH] added documentation report template --- doc/.gitignore | 8 +++++++ doc/doc.synctex.gz | Bin 0 -> 4450 bytes doc/doc.tex | 55 +++++++++++++++++++++++++++++++++++++++++++++ doc/make_report.sh | 1 + doc/references.bib | 13 +++++++++++ 5 files changed, 77 insertions(+) create mode 100644 doc/.gitignore create mode 100644 doc/doc.synctex.gz create mode 100644 doc/doc.tex create mode 100755 doc/make_report.sh create mode 100644 doc/references.bib diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..81ad0d8 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,8 @@ +*.log +*.pdf +*.aux +*.bbl +*.blg +*.fdb_latexmk +*.fls +*.out diff --git a/doc/doc.synctex.gz b/doc/doc.synctex.gz new file mode 100644 index 0000000000000000000000000000000000000000..99dd06176d1d3cdcdc9ecd9af793484e6ba9c228 GIT binary patch literal 4450 zcmV-o5uNTIiwFP!000001I=AsZ}c{HzW1+4?rgw*NBkz|b{n*NQS1W!z!pJJXf&D` z#TscMX&ift{`Vg0ixf%Oe$x(JB(W);Bc6wcT>P2XuCPp=X`Tc-!}hHXV-IHb?xRKi|(JUyAA!Tkehv-ZNBNB-@5#Dd<$$=%HEFf^^G`qhq!Zt=vK`Hn+nc|%)uC-Sb%!q9`P*SX zTBf(Re0sa&O_Lwy#J9G48_ly@nm^`M-W1uUIQ0J4KP}Vz_BB5?>E%>p?dCaudr3>n zxVXLX=a)9`z;J6)762K;@y{>&9OU_k!aP_&R16@O{UL9&^pcyD1py^7FqGYEcHXzs zZ`(eK9=h?0vV>)*Hc|TPrq&J zH|0WyimUXTFPRuc;6t#O)z_+<6Sn=EQsUJ8j(OJ=U75FCQ&dOi(MEGqew+xpzH|_} zv?gUExG6CX2=cD3%Ux{}mVJCvQgpiGWsmYI`vw!lWIYNc7FCy}<^0>OeT0C})c)#J zJ^~9~n^OO0SNW#wH@SRQbP$Y;zijJKBEem8oZ8$ZZ4?nmaF@3EChd0lu{{+}5DnP& zBgBO!93R2}yW>S*y|MZ)dGnT6d$;}(NDo4eYjr5fJUivtv-4JJYSh6oHeW7zk>urn>w2n+~oVVDB@F<_E*OT<_kn_-we`Cf>y zJ}wURet$`ixk=eRh(LueY4dxr?@n{VwjY5CUx&?+S9foOMr6T$Bn|+qVHlGJ&uMoW z06=^?ZB<9$!QN)KE9Zp0RUUy0^)^7eNt-5pvn@wpz^v%<{)cTh#<9rpusJj}#M{-r zOy3{|?~3QY+aMwkp9TTzq9Pj*z@rTy0`F-6I`AvHB5(Cmvj_p$O^I*bpmss%2VKay zuB?ERMcF6}gXz6x%}FfEF-ov?vU;D}UWs##0!Vc4Z1R^vpSoHAcm#U%$4Lgp>@&Rx z9H~LHZ*7;KXB6$?M2kl`NLhj5bPIk{3SI4>{TZJNCCW-V2&F7`P1?L2in7a_eD5KP zvc?WHm=)geXcX&r8b8+N(Kt4MW?*~`%0?88X?;X(edsO_5qkY58t3|$E=}Fl5GA^p zM3i026(V-A#5vanEIMA-iF2TpL^L|KQD_eGkVGS68_6YY+Pv|wL}Ozc%i&sO!$GGD zCmIEZ;q;x^0~L*v!=UtLSY6fU91=dbXcQd=*QC|HK6|L5(ezrkIzxXiS_n;DWYNfa zwTF2GDWj3~N*mVK%8Q2Nm$0@0buL=3v&%2xaD%C+y8M_!3|Vw17>jkmBK;bS|?`mTLjSdZ~}v9VrXmUWL1B!ksM zt^X7SB-*$0Zec&h9Sh5TpI88hamk`Q*8TZOYm!B_KoRTuS#ju2PVbNKb#ZT64|=@_ zSzLOL6XNPPrJWNC0I_0R2SVU8LUh{;XX{wpx#+gn&Q@`RzN0~LE}_j>+Bbs-(xco* z6)UtIP(l1)V2#0qk11AgJ7B8I{kW;1cNymVA-la^F8^89>E8eP2Ho~n+ee}8;d1p6 z#R_RZ>$%I~1MsI3ifR{tV}-T@V2x#d3Vq#$ZhKKKFdo1m{W0zp%$b2<<@ylg68$G2 z>KNEV8FvZ@qZ}^5c+ld`3Snp~YrWfE(etoX*K?QdN&~BZYENn43u|=S%X^>n+dlv8 z8W3r5J0DftiC~IDru~dLp1w8*eKZ`} z*tqT8!L5A+*0OpG}bi!v!@h(Ju_CRExXLS?)Y7)h} zGwGckz6&ebq2?cPqHg$e-CRx~@`!iO(%`hfSz+1dAxGOQ`lH@%@=KX!LF~~EO260L z?_mCd^@M#uYIdZnuD&+q)nACkyXE=mV_kr(rz4*%;@tvW`#56-SA^r%lI(Q6UhPdP zu;kMBLO=aC>(i^L0sW5m>T5T@$Nu1ZH|0*<-SgLOI3_zk7sW@ zfzrY7)8+YS9{L-6_8%;ca9r8{1kW4_3rPQW9_GIsfb`AAPdDdoS5EKU_V%H3>U=%7 zsrkPSpxa(D^lk67?Y~?*Z5&*9_s{9EDh@@~PYC)e@Z|2_sse!B{q2Xp91d;XZIiqI zFv&mlEZA-De#8tX;_koD-OuO|7PnLojwOGjN=V6IL=sFAgmLmnS;8=u@-ewPEmeo# z+vE}cxx0TyHke3)Z$Qd^qD=uWOOcR-C!Q*j0x8OkrjVQxJY!$gOXh}oSH;w01}6}fN-_%^ zO(;|!58x=8RY8t0FxITe5`n3t-=lcHP^29E!Ys!iP~?I=5}GiCb)$ebN~EMh;#pmA zP9(#+!Xfd{ps$0FA|#;^C!y{yeKzL`Ak5jLwnCUHMqO}uLv zB@|(3QN<~Y)MH3{MCO)ZqYlfaj)8!{2%Cifj*^6p-O&?EkP0Zvfp-5XZOjPxV(Jl& z^8ZO0V;=+-;R%&)HlhUjvGB5$l!BP-v22Vf6y%kSxkL;jH=7Yf7(#9#j8i7Da zrQ*!hcC+t;*<05cO;1MwHAxAjYEpX`xISd)!S%jiP#q~g=lxOn`^p&mA0mW{#3&;S z%_L^-(J~0}W)q`ju3$1y#`5#BT5e(YVetokG-@CEal)Y|hmmK1un88(8CZNASe_VW zKBd+M)<@clW^t9juZ$5rmlB$g&dLxR0&9_pwk5%OR+vqUR0nASH0Zr`9~OuGA5dHK zzpFa;B^Z9PGPY< z1G>VsY;ElqCmi#GC?W&|d4zkB+pG$DNXJFC>Pl!9Qq|tYCfG|5=fLeowVy2zgko~& z;CL&+7x1sqWn2;^hOosK_niQ5!Nr*MV|vUUv=x_qjOb`12;jJ&#LI_x4i-4dEym9u zu zWIy+|4Z7Jl#RB4H)mJN^Fv7N?b4*}lQL)}&Y%3+_4ETB0)$=hYtT*C|d(3RBAP)&* zvIlJ?6_$*++6Y2*0@I9_50yy>mu@kB{(#lgcnOw{HRq=0dW>LX^=b;k92#t{Iftr2 zFbebPtjjn=onolDFYYn(trD=#Ld0Yb+R%j(P8D(0^}2xx-RMp}EbpMzs8F#VCm_5`9tN5tCqE!TqTUFAoQRx1+BXZ;uEFxI>P8OA)rz` zq$ZkprtCpmF^D(_akX{Ff!LUN`IzHGQ05i`Lkt`)eSLx<@`l*k&4-AZQS8C-^M^Vc z54x4s9uyFs7#9kdD!E*x^j=wUh_f_xP0E}m9QDi=lut&y_of}K?~y`3=6KjG>-T~l zR;@mOyLyQZwG@z(5gpeAV-1bR+$v5U6I%-WsxW^<5Q;NcgXk}71W$C_#9%qAXKLU? zGU`)bKLJI-m>$QX-&_dm%>q~r0I4Sd!Ms~G3hq|~TMnx|#KU&IQeGzkWMFCmdRWK$ zFu$cYr(k%vXxWxZ9Sn2V4$L4V0b&#W8&GcnIeWr52@!bUjl)$R9+Kn z308XE3%tW%K>*F{LbT_@2_nT1@h~}-8qk;qBSBV2REPx;oCef{8I^z~+e z8H}!A9!8_!ens%kU<{P!N)oqry<{d77oscKCLyv>5EL@KRQAb+jE)C&NUMIGGOCYOkY!~qhyrU;JaS%0 zrSIIsdEqRZ_E*e`cK3c=;wf1~+;9DnCGAwP0<_t(1Z o((|s&w|9Ti{|`wZF{w|id%+KF))bfSdfwjs4-&V?mpp+00R9$=00000 literal 0 HcmV?d00001 diff --git a/doc/doc.tex b/doc/doc.tex new file mode 100644 index 0000000..4eabcac --- /dev/null +++ b/doc/doc.tex @@ -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} diff --git a/doc/make_report.sh b/doc/make_report.sh new file mode 100755 index 0000000..d0052d7 --- /dev/null +++ b/doc/make_report.sh @@ -0,0 +1 @@ +latexmk -pdf doc.tex diff --git a/doc/references.bib b/doc/references.bib new file mode 100644 index 0000000..d39bd9a --- /dev/null +++ b/doc/references.bib @@ -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 +} \ No newline at end of file