Kristian Schultz пре 4 година
родитељ
комит
cb6a54da57
4 измењених фајлова са 114 додато и 14 уклоњено
  1. 6 1
      src/config.tex
  2. 90 0
      src/faq/addThingsToProject.tex
  3. 17 13
      src/faq/doNotStore.tex
  4. 1 0
      src/translation.tex

+ 6 - 1
src/config.tex

@@ -102,6 +102,11 @@
 \newcommand{\var}[1]{\texttt{\color{grey} #1}}
 \newcommand{\code}[1]{\colorbox{lightgray}{\texttt{#1}}}
 \newcommand{\codeline}[1]{\par\colorbox{lightgrey}{\parbox{\linewidth}{\tt #1}}}
+\newcommand{\bobOnEarth}[2]{\textcolor{gray}{[bob@earth {#1}] (#2)\$}}
+\newcommand{\home}{{\~{}}}
+\newcommand{\projectDir}{{\~{}/myProject}}
+
+\newcommand{\q}[1]{\glqq{}{#1}\grqq{}}
 
 \NewEnviron{Code}{\colorbox{lightgrey}{\begin{minipage}{\linewidth}\parInit\tt \BODY{}\end{minipage}}}
 
@@ -111,7 +116,7 @@
 % Diverses
 % ===================================================================
 
-\renewcommand{\theenumi}{(\alph{enumi})}
+%\renewcommand{\theenumi}{(\alph{enumi})}
 
 \newcommand{\parInit}[0]{\setlength{\parskip}{1em}\setlength{\parindent}{0pt}}
 

+ 90 - 0
src/faq/addThingsToProject.tex

@@ -0,0 +1,90 @@
+\section{\de{Mit dem Repository arbeiten}\en{Working with the Repository}}
+
+\subsection{Workflow}
+
+\begin{DE}
+Beim Bearbeiten von Daten in einem GIT-Repository wird in den meisten F\"allen ein Workflow wie der hier Vorgestellte Workflow verwendet.
+\end{DE}
+\begin{EN}
+During the work with a GIT repository usualy one follows a workflow like this.
+\end{EN}
+
+\begin{enumerate}
+\item \de{Die aktuellsten \"Anderungen vom Server holen.}\en{Load the newest changes from server.} \hfill \var{pull}
+\item \de{Falls notwendig: Den aktuellen Arbeitszweig wechseln oder einen neuen anlegen.}\en{If needed: change or crate a branch.} \hfill \var{checkout} / \var{branch}
+\item \de{Dateien hinzuf\"ugen, \"andern oder l\"oschen.}\en{Add, change or remove files.} \hfill \var{add} / \var{remove}
+\item \de{\"Anderungen mit einem sinnvollen Kommentar comitten.}\en{Commit changes: Add a meaningfull comment.} \hfill \var{commit}
+\item \de{Neueste Comits zum Servre senden.}\en{Send newest comits to server.} \hfill \var{push}
+\end{enumerate}
+
+
+\subsection{\var{pull}}
+\index{GIT!pull}
+
+\begin{DE}
+   Mit \code{git pull} k\"onnen die aktuellsten \"Anderungen vom Server geladen werden.
+   Diese werden auf das aktuelle Arbeitsverzeichnis angewendet.
+\end{DE}
+\begin{EN}
+   With \code{git pull} you may load the newes changes from server to your local woring directory.
+\end{EN}
+
+
+\subsection{\de{Arbeitszweig\index{GIT!Arbeitszweig}}\en{Working branch}}
+\index{GIT!branch}
+\index{GIT!checkout}
+
+\begin{DE}
+   Arbeitszweige sollten immer dann angelegt werden, wenn Sie vorhaben neue Dinge Ihrem Projekt hinzuzufuegen oder Gr\"o\"sere \"Anderungen vorzunehmen. Wenn sie Ihre \"Anderungen durchgefuehrt und erfolgreich getestet haben, k\"onnen Sie den Arbeitszweig wirder mit dem Hauptzweig vereinigen.
+\end{DE}
+\begin{EN}
+\end{EN}
+
+\begin{itemize}
+\item
+   \codeline{git branch}
+   \de{Zeigt den aktuellen und die auf diesem Computer verf\"ugbaren Arbeitszweige an.}\en{Shows the current and the available branches on this computer.}
+
+\item
+   \codeline{git branch myNewFeature}
+   \de{Legt einen neuen Arbeitszweit mit den Namen \var{myNewFeature} an. Es werden die Daten aus dem aktuellen Arbeitszweig kopiert.}\en{Creates a new branch with the name \var{myNewFeature}. It contains a copy of all data from the current branch.}
+
+\item
+   \codeline{git checkout myOtherNewFeature}
+   \de{Wechselt zum Arbeitszweig mit dem Namen \var{myOtherNewFeature}.}\en{Changes to the branch with the name \var{myOtherNewFeature}}
+
+\item
+   \codeline{git merge myNewFeature}
+   \de{Vereinigt den Arbeitszweig \var{myNewFeature} in den aktuellen Arbeitszweig.}\en{Merges the branche \var{myNewFeature} in the current branch.}
+\end{itemize}
+
+\tExample{}:
+\begin{DE}
+Der aktuelle Arbeitszweig ist \var{master}. Es soll die Datei \var{example.c} hinzugef\"ugtund die Datein \var{main.c} bearbeitet werden.
+\end{DE}
+\begin{EN}
+The current branch is  \var{master}. The new file \var{example.c} is to be created and the file \var{main.c} needs to be edited.
+\end{EN}
+
+\begin{Code}
+\bobOnEarth{\projectDir}{master} git pull
+\\{}\bobOnEarth{\projectDir}{master} git branch example
+\\{}
+\\{}\bobOnEarth{\projectDir}{example} vim example.c
+\\{}\bobOnEarth{\projectDir}{example} git add example.c
+\\{}
+\\{}\bobOnEarth{\projectDir}{example} vim main.c
+\\{}\bobOnEarth{\projectDir}{example} git add main.c
+\\{}
+\\{}\bobOnEarth{\projectDir}{example} git commit -m \"{}Added new example function.\"{}
+\\{}\bobOnEarth{\projectDir}{example} git push
+\\{}
+\\{}\bobOnEarth{\projectDir}{example} git checkout master
+\\{}\bobOnEarth{\projectDir}{master} git pull
+\\{}\bobOnEarth{\projectDir}{master} git merge example
+\\{}\bobOnEarth{\projectDir}{master} git push
+\end{Code}
+
+
+
+\subsection{\de{Dinge hinzufuegen}\en{Adding things}}

+ 17 - 13
src/faq/doNotStore.tex

@@ -120,24 +120,29 @@ Bei Repositories $\geq$ 500MB mahnen wir.
 \begin{itemize}
 \item \var{Makefile}
 \item \var{.gitignore}
+   \item \badvar{a.out}
    \item \var{guessMyNumber.c}
-   \item \var{guessMyNumber.o}
+   \item \badvar{guessMyNumber.o}
+   \item \badvar{myLibrary.a}
+   \item \var{myLibrary.c}
+   \item \badvar{myLibrary.o}
+   \item \badvar{myLibrary.so}
    \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.
+   Die \ext{c} Dateien sind Quelltexte.
    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.
+   Die \ext{o} Dateien sind Compiler-Zwischenergebnisse.
+   Die Datei \var{a.out} ist das Ausf\"uhrbare Programm nach dem Compilieren und Linken.
+   Die Dateien \var{myLibrary.a} und \var{myLibrary.so} sind aus \var{myLibrary.c} erstellte Bibliotheken.
    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\~}).
+   Der Editor legt w\"ahrend des Bearbeitens \ext{swp} Dateien an.
+   Beim Speichern legt der Editor Backups an (z.B: \var{myLibrary.c\~}).
    Die Backup-Dateien und die \ext{swp} Dateien sollen nicht in das Repository.
 
    Die \var{.gitignore} k\"onnte wie folgt aussehen:
@@ -147,13 +152,12 @@ Bei Repositories $\geq$ 500MB mahnen wir.
 \end{EN}
 
 \begin{Code}
-{*}.swp\\
-{*}\~\\
-{*}.aux\\
-{*}.idx\\
-{*}.toc\\
+{*}.a\\
+{*}.so\\
+{*}.o\\
 {*}.out\\
-{*}.log
+{*}\~\\
+{*}.swp\\
 \end{Code}
 \end{minipage}
 

+ 1 - 0
src/translation.tex

@@ -20,3 +20,4 @@
 \newcommand{\tzB}{\de{z.B:}\en{e.G:}}
 
 
+\newcommand{\tExample}{\de{Beispiel}\en{Example}}