diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..25623708a --- /dev/null +++ b/docs/README.md @@ -0,0 +1,66 @@ +# TimeSafari Docs + +## Generating PDF from Markdown on OSx + +This uses Pandoc and BasicTex (LaTeX) Installed through Homebrew. + +### Set Up + +```bash +# See https://daniel.feldroy.com/posts/setting-up-latex-on-mac-os-x +brew install pandoc + +brew install basictex + +pandoc keystore-migration.md -o keystore-migration.pdf + +# Setting up LaTex packages + +# First update tlmgr +sudo tlmgr update --self + +# Then install LaTex packages +sudo tlmgr install titlesec +sudo tlmgr install framed +sudo tlmgr install threeparttable +sudo tlmgr install wrapfig +sudo tlmgr install multirow +sudo tlmgr install enumitem +sudo tlmgr install bbding +sudo tlmgr install titling # Required for the fancy headers used +sudo tlmgr install tabu +sudo tlmgr install mdframed +sudo tlmgr install tcolorbox +sudo tlmgr install textpos +sudo tlmgr install import +sudo tlmgr install varwidth +sudo tlmgr install needspace +sudo tlmgr install tocloft # Required for \tableofcontents generation +sudo tlmgr install ntheorem +sudo tlmgr install environ +sudo tlmgr install trimspaces +sudo tlmgr install lastpage # Enables Page X of Y +sudo tlmgr install collection-fontsrecommended # And set up fonts +sudo tlmgr install libertine # The main font the doc uses + + +``` + +### Usage + +Use the `pandoc` command to generate a PDF. + +```bash +pandoc usage-guide.md -o usage-guide.pdf +``` + +And you can open the PDF with the `open` command. + +```bash +open usage-guide.pdf +``` + +Or use this one-liner +```bash +pandoc usage-guide.md -o usage-guide.pdf && open usage-guide.pdf +``` diff --git a/docs/images/timesafari-logo-binoculars.png b/docs/images/timesafari-logo-binoculars.png new file mode 100644 index 000000000..172fd1332 Binary files /dev/null and b/docs/images/timesafari-logo-binoculars.png differ diff --git a/docs/images/timesafari-logo.png b/docs/images/timesafari-logo.png new file mode 100644 index 000000000..ec8cb09f9 Binary files /dev/null and b/docs/images/timesafari-logo.png differ diff --git a/docs/usage-guide.md b/docs/usage-guide.md new file mode 100644 index 000000000..527322911 --- /dev/null +++ b/docs/usage-guide.md @@ -0,0 +1,73 @@ +--- +geometry: margin=1in +header-includes: + - \usepackage{graphicx} + - \usepackage{titling} + - \usepackage{fancyhdr} + - \usepackage{lastpage} + - \pagestyle{fancy} + - \fancyhead[L]{Time Safari Usage Guide} + - \fancyhead[C]{Page \thepage\ of \pageref{LastPage}} + - \fancyhead[R]{} + - \fancyfoot[L]{} + - \fancyfoot[C]{} + - \fancyfoot[R]{\includegraphics[width=1cm]{images/timesafari-logo.png}} + - \usepackage{tocloft} + - \usepackage{libertine} + - \renewcommand{\familydefault}{\sfdefault} + - \fancypagestyle{tocstyle}{ + \fancyhead[L]{Time Safari Usage Guide} + \fancyhead[C]{Page \thepage\ of \pageref{LastPage}} + \fancyhead[R]{} + \fancyfoot[L]{} + \fancyfoot[C]{} + \fancyfoot[R]{\includegraphics[width=1cm]{images/timesafari-logo-binoculars.png}}} +--- + +\begin{titlepage} +\centering +\vspace*{\fill} +{\huge\textbf{TimeSafari Usage guide}} + +\vspace{1cm} +{\Large Signing up users, adding contacts, and adding gifts.} + +\vspace{1cm} +\includegraphics[width=0.5\textwidth]{images/timesafari-logo.png} +\vspace*{\fill} + +\vspace{1cm} +{\Large Trent Larson, Kent Bull} + +\vspace{0.5cm} +{\large 2024-06-25} + +\end{titlepage} + +\clearpage + +\begin{center} +\includegraphics[width=2cm]{images/timesafari-logo-binoculars.png} +\end{center} +\tableofcontents + +\clearpage + + +# Purpose of Document + +Both end-users and development team members need to know how to use TimeSafari. +This document serves to show how to use every feature of the TimeSafari platform. + +Sections of this document are geared specifically for software developers and quality assurance +team members. + +Companion videos will also describe end-to-end workflows for the end-user. + +# TimeSafari + +## Overview + +### End Users + +### Software Developers