blob: 4d88acef0e76dc1d0e6d2451a7bed3f4238b1c65 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
\documentclass{article}
\usepackage{fullpage}
\usepackage{hyperref}
\begin{document}
\title{150 Smoots Getting Started on Linux}
\author{Andrew Chen}
\date{\today}
\maketitle
\section{Repository Access}
\begin{itemize}
\item \textbf{Install} Git packages with \texttt{sudo apt-get install git-core git-gui git-doc}. Set up your basic git settings \href{http://help.github.com/git-email-settings/}{like so}.
\item \textbf{Sign up} for a GitHub account (\href{https://github.com/signup/free}{here}) then ask Russell to add your account as a collaborator to the rcoh/SmootLight code repository.
\item \textbf{Connect} to the SmootLight GitHub code repository. Generate SSH keys and upload the public one to GitHub by following the instructions \href{http://help.github.com/linux-key-setup/}{here}.
\item \textbf{Clone and branch} the code repository; use \href{http://help.github.com/git-cheat-sheets/}{this cheatsheet} for help as necessary.
\end{itemize}
\section{Testing on Pygame}
\begin{itemize}
\item \textbf{Install} Pygame with \texttt{sudo apt-get install python-pygame}.
\item \textbf{Setup} logging by running \texttt{./setup.sh}.
\item \textbf{Run} your LightInstallation code with \texttt{python LightInstallation.py}.
\end{itemize}
\section{Repository Check In}
\begin{itemize}
\item \textbf{Stage} files to be committed with \texttt{./ga}.
\item \textbf{Commit} your changes locally with \texttt{git commit}.
\item \textbf{Push} your changes to your branch with \texttt{git push origin yourbranchname}.
\item \textbf{Request a pull} to the source repository by following instructions \href{http://help.github.com/pull-requests/}{here}.
\item \textbf{Learn more} about working with remote repositories \href{http://help.github.com/remotes/}{here}.
\end{itemize}
\section{Latex Documentation}
\begin{itemize}
\item \textbf{Install} Latex packages to be consistent with current documentation style. I had to run \texttt{sudo apt-get install texlive-fonts-recommended texlive-latex-extra} to successfully convert Russell's .tex to pdf.
\item \textbf{Edit} the .tex files with any text editor. I use vim for quick edits and gedit with the Latex plugin for autocompletion and quick previews. Get the Latex plugin with \texttt{sudo apt-get install gedit-latex-plugin}.
\item \textbf{Publish to PDF} with \texttt{pdflatex yourfile.tex}.
\item \textbf{View PDF} with \texttt{evince yourfile.pdf}.
\end{itemize}
\end{document}
|
