aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
author Justin Nolan <justin@nolan.de>2023-02-10 21:10:01 +0100
committer Justin Nolan <justin@nolan.de>2023-02-10 21:10:01 +0100
commit43440dc83204464a0bee3d152e77c36030dac3b2 (patch)
treefa9138f45da8d20d677a15a9ad58b1f04d018138 /docs
parent2fc3fa669fcf91dd213db1f4169bdafba84c5a97 (diff)
Remove Latex files
Diffstat (limited to 'docs')
-rw-r--r--docs/.gitignore3
-rw-r--r--docs/makefile7
-rw-r--r--docs/styleguide-cpp.pdfbin40093 -> 0 bytes
-rw-r--r--docs/styleguide-cpp.tex100
4 files changed, 0 insertions, 110 deletions
diff --git a/docs/.gitignore b/docs/.gitignore
deleted file mode 100644
index 6e25999..0000000
--- a/docs/.gitignore
+++ /dev/null
@@ -1,3 +0,0 @@
-*.aux
-*.log
-*.toc \ No newline at end of file
diff --git a/docs/makefile b/docs/makefile
deleted file mode 100644
index f5aeba8..0000000
--- a/docs/makefile
+++ /dev/null
@@ -1,7 +0,0 @@
-TARGET=styleguide-cpp.tex
-
-docs: $(TARGET)
- latex -output-format=pdf $(TARGET)
-
-clean:
- rm -f *.aux *.dvi *.log *.out *.toc \ No newline at end of file
diff --git a/docs/styleguide-cpp.pdf b/docs/styleguide-cpp.pdf
deleted file mode 100644
index bc58daf..0000000
--- a/docs/styleguide-cpp.pdf
+++ /dev/null
Binary files differ
diff --git a/docs/styleguide-cpp.tex b/docs/styleguide-cpp.tex
deleted file mode 100644
index c606d37..0000000
--- a/docs/styleguide-cpp.tex
+++ /dev/null
@@ -1,100 +0,0 @@
-\documentclass{article}
-\usepackage[colorlinks = true, urlcolor = blue, linkcolor = blue]{hyperref}
-\usepackage{multirow}
-
-
-%Setup for code snippets
-\usepackage{listings}
-\usepackage{xcolor}
-\definecolor{darkGreen}{RGB}{63,127,95}
-\lstset {
- language=C++,
- backgroundcolor=\color{black!3},
- basicstyle=\footnotesize,
- basicstyle=\ttfamily,
- keywordstyle=\color{blue}\ttfamily,
- stringstyle=\color{red}\ttfamily,
- commentstyle=\color{darkGreen}\ttfamily,
- morecomment=[l][\color{magenta}]{\#}
-}
-
-\usepackage{helvet}
-\renewcommand{\rmdefault}{\sfdefault} %Use sans-serif font family
-
-
-\title{OpenVic2 C++ Style Guidelines (Draft)}
-\author{ZincLadder}
-\date{\today\\v0.0.1}
-
-
-
-
-\begin{document}
-%=====================================
-
-\maketitle
-\tableofcontents
-\clearpage
-
-\section{Why Style?}
-You may be wondering "Why do we need a style guide?" "Are you trying to give me homework?"
-
-\subsection{General Principles}
-\begin{itemize}
- \item Prefer clarity over brevity
- \item Don't optimize prematurely
- \item Avoid C-style casts
-\end{itemize}
-
-\subsection{File Formatting}
-Source code files should adhere to the following:
-\begin{itemize}
- \item Encoded in UTF-8
- \item Use tabs for indentation
- \item Use LF for end-of-line sequences
- \item Not have any trailing whitespace (Lines which end in spaces or tabs)
- \item Any \#include directives should be at the top of the file
-\end{itemize}
-
-
-\section{Conventions}
-\subsection{Naming Conventions}
-
-\begin{table}[!ht]
- \begin{center}
- \caption{Basic Naming Conventions}
- \begin{tabular}{|l|l|l|}
- \hline
- \bf Item & \bf Writing Convention & \bf Example \\
- \hline
- Class and Struct Names & PascalCase & MyCoolExample \\
- Variables and Function Names & CamelCase & myCoolExample \\
- Constants, Enum Values, and Preprocessor & SnakeCase (all-caps) & MY\_COOL\_EXAMPLE \\
- Type aliases & SnakeCase (lower) & my\_cool\_example\_t \\
- \hline
- \end{tabular}
- \end{center}
-\end{table}
-
-\begin{lstlisting}
-#pragma once
-#include<stdio.h>
-#include<iostream>
-// A comment
-constexpr size_t UNIQUE_RGB_COLOURS = 256 * 256 * 256;
-
-struct RGBColour {
- unsigned char r;
- unsigned char g;
- unsigned char b;
-};
-
-bool isColourGreyscale(RGBColour c);
-
-class Something {
-
-};
-\end{lstlisting}
-
-%=====================================
-\end{document}