From 5c2862df926e27ddb62a3b99d39b54b3a8377fb4 Mon Sep 17 00:00:00 2001 From: Danila Fedorin Date: Thu, 28 May 2020 22:56:31 -0700 Subject: [PATCH] Build README instructions. --- Makefile | 37 ++++++++++++++++++++-- readme.tex | 93 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 128 insertions(+), 2 deletions(-) create mode 100644 readme.tex diff --git a/Makefile b/Makefile index c64bc0d..458327a 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,37 @@ -out.pdf: blog-daniel.pdf techreview-daniel.pdf design-doc.pdf requirements.pdf intro.pdf +archive.pdf: intro.pdf requirements.pdf design-doc.pdf \ + binary/techreview-ryan.pdf techreview-daniel.pdf binary/techreview-matt.pdf \ + binary/blog-ryan.pdf blog-daniel.pdf binary/blog-matt.pdf \ + readme.pdf + pdfjam --no-tidy --outfile archive.pdf -- intro.pdf requirements.pdf design-doc.pdf \ + binary/techreview-ryan.pdf techreview-daniel.pdf binary/techreview-matt.pdf \ + binary/blog-ryan.pdf blog-daniel.pdf binary/blog-matt.pdf \ + readme.pdf + +# Generate LaTeX files from READMEs +readme-app.tex: external/app/README.md + pandoc -f markdown-auto_identifiers -t latex --no-highlight -o readme-app.tex external/app/README.md + +readme-cdl.tex: external/cdl/README.md + pandoc -f markdown-auto_identifiers -t latex --no-highlight -o readme-cdl.tex external/cdl/README.md + +readme-server.tex: external/server/README.md + pandoc -f markdown-auto_identifiers -t latex --no-highlight -o readme-server.tex external/server/README.md + +# Matt's READMEs don't use the convention for headers; we need to update them so that every +# "section" is a subsection and so on. We also insert our own overarching section title. + +readme-collar.tex: external/collar/README.md + pandoc -f markdown-auto_identifiers -t latex --no-highlight -o readme-collar.tex external/collar/README.md + sed -i -e 's/section/subsection/g' readme-collar.tex + sed -i.old '1s;^;\\section{Collar Firmware};' readme-collar.tex + +readme-gateway.tex: external/gateway/README.md + pandoc -f markdown-auto_identifiers -t latex --no-highlight -o readme-gateway.tex external/gateway/README.md + sed -i -e 's/section/subsection/g' readme-gateway.tex + sed -i.old '1s;^;\\section{Gateway Software};' readme-gateway.tex + +readme.pdf: readme-app.tex readme-server.tex readme-collar.tex readme-gateway.tex readme-cdl.tex readme.tex + pdflatex readme.tex intro.pdf: intro.tex pdflatex intro.tex @@ -19,6 +52,6 @@ requirements.pdf: external/requirements/requirements.latex cd external/requirements && pdflatex -output-directory=../.. requirements.latex && pdflatex -output-directory=../.. requirements.latex clean: - rm -rf *.pdf *.out *.aux *.log *.toc + rm -rf *.pdf *.out *.aux *.log *.toc readme-*.tex .PHONY: clean diff --git a/readme.tex b/readme.tex new file mode 100644 index 0000000..cde2f43 --- /dev/null +++ b/readme.tex @@ -0,0 +1,93 @@ +\documentclass[10pt, draftclsnofoot,onecolumn, compsoc]{IEEEtran} + +\def\changemargin#1#2{\list{}{\rightmargin#2\leftmargin#1}\item[]} +\setlength{\parindent}{0pt} +\let\endchangemargin=\endlist + +\usepackage{hyperref} +\usepackage{framed} +\usepackage{textcomp} +\usepackage{todonotes} +\usepackage{caption} +\usepackage{pgfgantt} +\usepackage{setspace} +\linespread{1} + +\providecommand{\tightlist}{% + \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}} + +\def \CapstoneTeamName{Automated Fenceless Grazing} +\def \CapstoneTeamNumber{CS3} +\def \GroupMemberOne{Ryan Alder} +\def \GroupMemberTwo{Danila Fedorin} +\def \GroupMemberThree{Matthew Sessions} +\def \CapstoneProjectName{Automated Fenceless Grazing} +\def \CapstoneSponsorCompany{Oregon State University} +\def \CapstoneSponsorPerson{Bechir Hamdaoui} +\def \DocType{Project READMEs} + +\newcommand{\NameSigPair}[1]{\par +\makebox[2.75in][r]{#1} \hfil \makebox[3.25in]{\makebox[2.25in]{\hrulefill} \hfill \makebox[.75in]{\hrulefill}} +\par\vspace{-12pt} \textit{\tiny\noindent +\makebox[2.75in]{} \hfil \makebox[3.25in]{\makebox[2.25in][r]{Signature} \hfill \makebox[.75in][r]{Date}}}} + +\begin{document} + +\begin{titlepage} + \pagenumbering{gobble} + \begin{singlespace} + % 4. If you have a logo, use this includegraphics command to put it on the coversheet. + %\includegraphics[height=4cm]{CompanyLogo} + \par\vspace{.2in} + \centering + \scshape{ + \huge CS Capstone \DocType \par + {\large\today}\par + \vspace{.5in} + \textbf{\Huge\CapstoneProjectName}\par + \vfill + {\large Prepared for}\par + \Huge \CapstoneSponsorCompany\par + \vspace{5pt} + {\Large\NameSigPair{\CapstoneSponsorPerson}\par} + {\large Prepared by }\par + Group\CapstoneTeamNumber\par + % 5. comment out the line below this one if you do not wish to name your team + \CapstoneTeamName\par + \vspace{5pt} + {\Large + \NameSigPair{\GroupMemberOne}\par + \NameSigPair{\GroupMemberTwo}\par + \NameSigPair{\GroupMemberThree}\par + } + \vspace{20pt} + } + % \begin{abstract} + % The Fenceless Grazing Collar system aims to reduce the amount of work + % needed by farmers to keep herds of grazing animals. The project + % will be implemented using the LoRa wireless communication protocol to allow + % for long-range interaction between animal-worn collars and a gateway device. + % The gateway device will also provide an HTTP-based JSON API to apply configuration + % changes to collars through an application built for Android mobile devices. + % The MariaDB SQL database management system will be used to store the data + % received from the collar for viewing and analysis. + % \end{abstract} + \end{singlespace} +\end{titlepage} + +\pagebreak +\input{readme-app.tex} + +\pagebreak +\input{readme-server.tex} + +\pagebreak +\input{readme-cdl.tex} + +\pagebreak +\input{readme-gateway.tex} + +\pagebreak +\input{readme-collar.tex} + +\end{document}