kjodle/a-git-primer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates to chapter 5 and 6

Browse Source
This commit is contained in:
Kenneth John Odle 2025-01-26 16:41:12 -05:00
parent 25311b0973
commit c32b1e3c88
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
git-primer.tex
View File

@ -719,7 +719,7 @@ Notice that line 12 is telling us that the ``a'' version of ``\texttt{doc\_b.txt
I mentioned earlier that you could use Git if you're a writer to keep track of changes to projects, provided you were willing to work with text files. My goal here is to provide a basic workflow for doing that. I'm going to assume a few things: I mentioned earlier that you could use Git if you're a writer to keep track of changes to projects, provided you were willing to work with text files. My goal here is to provide a basic workflow for doing that. I'm going to assume a few things:
\begin{enumerate}[noitemsep] \begin{enumerate}[noitemsep]
\item You have a remote somewhere on a repository host (like GitHub or your own website). \item You have a remote repository somewhere on a host (like GitHub or your own website).
\item You write all your stories in plain text files in a local repo. \item You write all your stories in plain text files in a local repo.
\item Your repository host allows you to edit files on their website. (Codeberg uses Gitea\footnote{\kref{https://gitea.com/}{https://gitea.com/}} which allows this option, and other Git hosts have similar options.) \item Your repository host allows you to edit files on their website. (Codeberg uses Gitea\footnote{\kref{https://gitea.com/}{https://gitea.com/}} which allows this option, and other Git hosts have similar options.)
\end{enumerate} \end{enumerate}
@ -768,11 +768,11 @@ In this approach, you create your local directory first using \texttt{git init}.
This approach has numerous advantages. You can begin making commits at once, and then push everything to your remote only when you are ready. This also allows you to experiment with a number of different projects and then make only those public that you feel are high enough quality to share with the world. This approach has numerous advantages. You can begin making commits at once, and then push everything to your remote only when you are ready. This also allows you to experiment with a number of different projects and then make only those public that you feel are high enough quality to share with the world.
This approach has one main advantage, however. Because your work exists only on your local machine, if something happens to your computer, you will lose all of your work. This can be mitigated by making regular backups. This approach has one main disadvantage, however. Because your work exists only on your local machine, if something happens to your computer, you will lose all of your work. This can be mitigated by making regular backups.
\section{README.md} \section{README.md}
If you pull or clone a remote repository, you may notice files like \texttt{.gitignore} and \texttt{README.md}. The first tells Git which files to \textit{not} track. (And yes, you will want to make use of this at some point.) The second is a text document written in Markdown (hence the \texttt{.md} file extension) which appears on the front page of the online repo. If you pull or clone a remote repository, you may notice a file called \texttt{README.md}. This is a text document written in Markdown (hence the \texttt{.md} file extension) which appears on the front page of the online repo. You can include images and links, as well as licensing information. (I have a quick guide to Markdown syntax at \kref{https://codeberg.org/kjodle/markdown_syntax}{https://codeberg.org/kjodle/m\\arkdown\_syntax}.)
\section{Forks and Pull Requests} \section{Forks and Pull Requests}