Selaa lähdekoodia

added clone, project examples

Kristian Schultz 4 vuotta sitten
vanhempi
commit
b150412afd
6 muutettua tiedostoa jossa 193 lisäystä ja 26 poistoa
  1. 1 0
      src/config.tex
  2. 13 1
      src/content.tex
  3. 20 0
      src/faq/cloneProject.tex
  4. 153 12
      src/faq/doNotStore.tex
  5. 2 13
      src/faq/newProject.tex
  6. 4 0
      src/translation.tex

+ 1 - 0
src/config.tex

@@ -98,6 +98,7 @@
 \definecolor{grey}{gray}{0.5}
 \definecolor{lightgrey}{gray}{0.95}
 
+\newcommand{\badvar}[1]{\texttt{\color{red} #1}}
 \newcommand{\var}[1]{\texttt{\color{grey} #1}}
 \newcommand{\code}[1]{\colorbox{lightgray}{\texttt{#1}}}
 \newcommand{\codeline}[1]{\par\colorbox{lightgrey}{\parbox{\linewidth}{\tt #1}}}

+ 13 - 1
src/content.tex

@@ -1,6 +1,18 @@
 \parInit
-\maketitle
+\thispagestyle{empty}
 
+~
+\vspace{7cm}
+
+\begin{center}
+\Huge GitLab HowTo
+\\\small Uni-Rostock 05.2021
+\end{center}
+%\maketitle
+
+\newpage
+\thispagestyle{fancy}
+\setcounter{page}{1}
 \tableofcontents
 
 

+ 20 - 0
src/faq/cloneProject.tex

@@ -0,0 +1,20 @@
+\section{\de{Repository clonen}\en{Clone a repository}}
+\label{project:clone}
+\begin{itemize}
+\item \de{\"Offnen Sie Ihr Projekt auf \urlBase{}.}\en{Open your project on \urlBase{}.}
+
+\item \tClickOn{Clone} \de{und kopieren Sie den Link unter}\en{and copy the link below} \var{Clone with SSH}
+
+    \includegraphics[width=\linewidth]{images/newProject/projectPage.png}
+
+\item \de{\"Offnen Sie ein Terminal.}\en{Open a terminal.}
+
+\item \de{Navigieren Sie zum Ordner, in dem Sie das Repository speichern wollen.}\en{Navigate to the folder, where you want to store your repository.}
+
+    \codeline{cd \textbf{my/favorite/repo/storage/directory}}
+
+\item \de{Ersetzen Sie im unten stehenden Befehl \textbf{git@git.informatik.uni-rostock.de:example-user/example-project.git} durch den eben kopierten Link und f\"uhren Sie den Befehl aus.}\en{In the command below replace \textbf{git@git.informatik.uni-rostock.de:kristian/example-project.git} with the link you copied before. Execute the command.}
+
+    \codeline{git clone \textbf{git@git.informatik.uni-rostock.de:example-user/example-project.git}}
+\end{itemize}
+

+ 153 - 12
src/faq/doNotStore.tex

@@ -1,23 +1,164 @@
-\section{\de{Was \underline{nicht} in GIT gespeichert werden sollte}\en{What \underline{not} to store in in GIT}}
+\section{\de{Gespeicherte Daten verwalten}\en{Manage stored data}}
+\subsection{\de{Was \underline{nicht} in GIT gespeichert werden sollte}\en{What \underline{not} to store in in GIT}}
 
 Die folgenden Daten sollten nicht im GIT gespeichert werden. Insbesondere wenn die Datei > 1MB ist.
 
-\newcommand{\ext}[1]{\texttt{*.#1}}
+\newcommand{\ext}[1]{\var{*.#1}}
 
 \begin{itemize}
-\item Videos (z.B: \ext{avi} / \ext{mp4} / \ext{wmv})
-\item Bilder (z.B: \ext{jpg} / \ext{png} / \ext{tiff} / \ext{bmp} / \ext{xcf} / \ext{ppt} / \ext{pptx} / \ext{psd})
-\item Ton-Dateien (z.B: \ext{wav} / \ext{mp3} / \ext{flac} / \ext{ogg})
-\item Programme / Installer (z.B: \ext{exe} / \ext{msi} / \ext{o /} \ext{jar})
-\item Binaerdateien (z.B: \ext{bin} / \ext{dat} / \ext{zip} / \ext{gz} / \ext{bz})
-\item Dateien, die sich aus den bereits vorhandenen Quelltexten herstellen lassen.
-\item Zwischen Dateien, die w\"ahrend des Bauvorganges entstehen. (z.B: \ext{o} / \ext{class})
-\item Programm- / Debugausgaben (z.B: \ext{log}, \ext{dat})
+\item Videos (\tZB{} \ext{avi} / \ext{mp4} / \ext{wmv})
+\item \de{Bilder}{Images} (\tZB{} \ext{jpg} / \ext{png} / \ext{tiff} / \ext{bmp} / \ext{xcf} / \ext{psd})
+\item \de{Pr\"asentationen}{Presentations} (\tZB{} \ext{ppt} / \ext{pptx} / \ext{pdf})
+\item \de{Ton-Dateien}\en{Audio-Files} (\tZB{} \ext{wav} / \ext{mp3} / \ext{flac} / \ext{ogg})
+\item \de{Programme, Bibliotheken, Installer}\en{Executables, Libraries, istaller} (\tZB{} \ext{exe} / \ext{dll} / \ext{lib} / \ext{msi} / \ext{o} / \ext{so} / \ext{class} / \ext{jar})
+\item Bin\"ardateien (\tZB{} \ext{bin} / \ext{dat} / \ext{zip} / \ext{gz} / \ext{bz})
+\item Dateien, die sich generieren lassen.
+\item Dateien, die w\"ahrend des Bauvorganges entstehen. (\tZB{} \ext{o} / \ext{class})
+\item Programm- / Debugausgaben (\tZB{} \ext{log}, \ext{dat})
+\item Ordner anderer Versionsverwaltungssysteme (\tZB \var{.svn})
+\item Backups, Tempor\"are Editor-Dateien, Lokale Workspace-Konfigurationen (\tZB \ext{swp} / \var{*\~})
 \end{itemize}
 
-Repositories sollten mit History < 200Mb bleiben.
+Repositories sollten mit History < 300Mb bleiben.
 \\
 Bei Repositories $\geq$ 500MB mahnen wir.
 
 
-\section{\de{Was in ein GIT-Repository gehoert.}\en{What to store in a GIT repository.}}
+\subsection{\de{Was in ein GIT-Repository gehoert.}\en{What to store in a GIT repository.}}
+\begin{itemize}
+\item \de{Quelltexte}\en{Sourcecode}
+\item \de{Dokumentationen}\en{Documentation}
+\item Makefiles
+\item \de{Zum Bauen erforderliche Konfigurationen.}\en{Configuration, needed to build your project.}  
+\item \de{Notwendige Dateien, die nicht generiert oder aus dem Internet / anderen Repositories geladen werden k\"onnen.}\en{Needed files, that can't be generated or loaded from the internet or other repositories.}
+\end{itemize}
+
+\newpage
+\subsection{Von GIT verwaltete Dateien konfigurieren}
+
+\begin{DE}
+   In jedem Ordner des von GIT verwalteten Repositories kann eine Datei \var{.gitignore} angelegt werden.
+   Dies ist eine Text-Datei, in der aufgelisted wird, welche Ordner oder Dateien bei einem \code{git add .} ignoriert werden sollen.
+   Dabei kann auch mit Wildcards (*) gearbeitet werden.
+\end{DE}
+\begin{EN}
+   In every folder of you GIT repository you may add a \code{.gitignore} file.
+   This is a text file, listing all folder or files that should be ignored by git.
+   You don't need to worry using \code{git add .}. It will not add these files.
+   In the list you may use wildcards (*).
+\end{EN}
+
+\subsubsection{\de{Beispiel: TeX Dokument}\en{Example: Tex Document}}
+
+\begin{minipage}[t]{0.39\textwidth}\parInit
+\de{Das Projekt hat diese Ordner-Struktur:}\en{The project has this folder structure:}
+\begin{itemize}
+\item \var{Makefile}
+\item \var{.gitignore}
+   \item \var{myPaper.tex}
+   \item \badvar{myPaper.pdf}
+   \item \badvar{myPaper.aux}
+   \item \badvar{myPaper.idx}
+   \item \badvar{myPaper.toc}
+   \item \badvar{myPaper.out}
+   \item \badvar{myPaper.log}
+   \item \var{chapter1.tex}
+   \item \badvar{chapter1.aux}
+   \item \badvar{.chapter1.aux.swp}
+   \item \var{chapter2.tex}
+   \item \badvar{chapter2.aux}
+   \item \badvar{chapter2.aux\~}
+   \item \ldots
+\item \var{images/}
+   \begin{itemize}
+   \item \var{logo.png}
+   \item \var{interestingGraphic.fig}
+   \item \ldots
+   \end{itemize}
+\end{itemize}
+\end{minipage}
+\hfill
+\begin{minipage}[t]{0.59\textwidth}\parInit
+\begin{DE}
+   Die \ext{tex} Dateien sind die Quelltexte zum TeX Dokument.
+   Im Ordner \var{images} sind f\"ur das Dokument wichtige Bilder oder Quelltexte, die diese Bilder generieren.
+   Diese Dateien sollten gespeichert werden.
+
+   Die Datei \var{myPaper.pdf} ist das compilierte Endprodukt.
+   Die \ext{log}, \ext{out}, \ext{aux}, \ext{toc}, \ext{idx} Dateien sind Nebenprodukte des Bauprozesses.
+   Diese Dateien sollten nicht in das Repository.
+
+   Der Editor legt w\"ahrend des Bearbeitens \ext{swp} Dateien an (z.B: \var{chapter1.swp}).
+   Beim Speichern legt der Editor Backups an (z.B: \var{chapter2.tex\~}).
+   Die Backup-Dateien und die \ext{swp} Dateien sollen nicht in das Repository.
+
+   Die \var{.gitignore} k\"onnte wie folgt aussehen:
+\end{DE}
+\begin{EN}
+   \ldots
+\end{EN}
+
+\begin{Code}
+{*}.swp\\
+{*}\~\\
+{*}.aux\\
+{*}.idx\\
+{*}.toc\\
+{*}.out\\
+{*}.log
+\end{Code}
+\end{minipage}
+
+
+
+
+
+\subsubsection{\de{Beispiel: C Projekt}\en{Example: C Project}}
+
+\begin{minipage}[t]{0.39\textwidth}\parInit
+\de{Das Projekt hat diese Ordner-Struktur:}\en{The project has this folder structure:}
+\begin{itemize}
+\item \var{Makefile}
+\item \var{.gitignore}
+   \item \var{guessMyNumber.c}
+   \item \var{guessMyNumber.o}
+   \item \ldots
+\end{itemize}
+\end{minipage}
+\hfill
+\begin{minipage}[t]{0.59\textwidth}\parInit
+\begin{DE}
+   Die \ext{tex} Dateien sind die Quelltexte zum TeX Dokument.
+   Im Ordner \var{images} sind f\"ur das Dokument wichtige Bilder oder Quelltexte, die diese Bilder generieren.
+   Diese Dateien sollten gespeichert werden.
+
+   Die Datei \var{myPaper.pdf} ist das compilierte Endprodukt.
+   Die \ext{log}, \ext{out}, \ext{aux}, \ext{toc}, \ext{idx} Dateien sind Nebenprodukte des Bauprozesses.
+   Diese Dateien sollten nicht in das Repository.
+
+   Der Editor legt w\"ahrend des Bearbeitens \ext{swp} Dateien an (z.B: \var{chapter1.swp}).
+   Beim Speichern legt der Editor Backups an (z.B: \var{chapter2.tex\~}).
+   Die Backup-Dateien und die \ext{swp} Dateien sollen nicht in das Repository.
+
+   Die \var{.gitignore} k\"onnte wie folgt aussehen:
+\end{DE}
+\begin{EN}
+   \ldots
+\end{EN}
+
+\begin{Code}
+{*}.swp\\
+{*}\~\\
+{*}.aux\\
+{*}.idx\\
+{*}.toc\\
+{*}.out\\
+{*}.log
+\end{Code}
+\end{minipage}
+
+
+
+
+
+

+ 2 - 13
src/faq/newProject.tex

@@ -1,4 +1,5 @@
 \section{\de{Neues Projekt erstellen}\en{Create new project}}
+\label{project:new}
 \subsection{\de{Mit der Kommandozeile}\en{Using the commandline}}
 \begin{itemize}
 \item \textbf{\de{Sie haben noch kein lokales Projekt?}\en{You have no local project?}}
@@ -76,19 +77,7 @@
     
     \de{Es erscheint die \"Ubersichtsseite des neuen Projektes.}\en{It appears the overview of your new project.}
 
-    \includegraphics[width=\linewidth]{images/newProject/projectPage.png}
-
-\item \tClickOn{Clone} \de{und kopieren Sie den Link unter}\en{and copy the link below} \var{Clone with SSH}
-
-\item \de{\"Offnen Sie ein Terminal.}\en{Open a terminal.}
-
-\item \de{Navigieren Sie zum Ordner, in dem Sie das Repository speichern wollen.}\en{Navigate to the folder, where you want to store your repository.}
-
-    \codeline{cd \textbf{my/favirite/repo/storage/directory}}
-
-\item \de{Ersetzen Sie im unten stehenden Befehl \textbf{git@git.informatik.uni-rostock.de:example-user/example-project.git} durch den eben kopierten Link und f\"uhren Sie den Befehl aus.}\en{In the command below replace \textbf{git@git.informatik.uni-rostock.de:kristian/example-project.git} with the link you copied before. Execute the command.}
-
-    \codeline{git clone \textbf{git@git.informatik.uni-rostock.de:example-user/example-project.git}}
+    \de{N\"achster Schritt ist, ihr neues Repository auf Ihren Computer zu clonen. (Kapitel \ref{project:clone})}\en{Next step is cloning jour Repository. (Chapter \ref{project:clone})}
 
 \end{itemize}
 

+ 4 - 0
src/translation.tex

@@ -1,4 +1,5 @@
 \newcommand{\urlSignIn}{\url{https://git.informatik.uni-rostock.de/users/sign\_in}}
+\newcommand{\urlBase}{\url{https://git.informatik.uni-rostock.de}}
 
 
 \newcommand{\tSelect}{\de{W\"ahlen sie}\en{Select}}
@@ -15,4 +16,7 @@
 \newcommand{\tUseSteps}{\de{Verwenden Sie Schritte }\en{Use steps}}
 \newcommand{\tUseAllSteps}{\de{Verwenden Sie alle Schritte }\en{Use all steps}}
 
+\newcommand{\tZB}{\de{Z.B:}\en{E.G:}}
+\newcommand{\tzB}{\de{z.B:}\en{e.G:}}
+