Skip to content

Commit 2ba4878

Browse files
authored
docs: Adds a ReadMe
Adds a ReadMe in the basic style outlined in the git tutorial document. Closes #9
1 parent 14f9ebc commit 2ba4878

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Table of Contents
2+
* [Git Tutorial](#git-tutorial)
3+
* [Getting Started](#getting-started)
4+
* [Prerequisites](#prerequisites)
5+
* [Running the Code](#running-the-code)
6+
* [Author](#author)
7+
* [Acknowledgements](#acknowledgements)
8+
* [Description of Each Script](#description-of-each-script)
9+
*[Git Tutorial.tex](git-tutorialtex)
10+
11+
# Git-Tutorial
12+
This repository contains the code and images for the LaTeX document for teaching Git to the Tyler Lab. The original document is version v1.0.0 and subsequent improvements were made starting with v2.0.0.
13+
This repository as a whole also stands as an example of many of the techniques used in the document for commiting correctly, making and managing issues, and creating releases.
14+
15+
# Getting Started
16+
If you plan on editing the document, you will need to download tools to edit LaTeX. Personally I use Texmaker and MiKTex. A video tutorial for installing these tools is located [here](https://www.youtube.com/watch?v=uKetjJTDSqk&t=60s).
17+
I also use Inkscape to create some of the images in the document and I use a tutorial found [here](https://castel.dev/post/lecture-notes-2/) to make them.
18+
19+
## Prerequisites
20+
* [Texmaker](https://www.xm1math.net/texmaker/)
21+
* [MiKTeX](https://miktex.org/)
22+
* [InkScape](https://inkscape.org/)
23+
24+
# Running the Code
25+
Open the Git Tutorial.tex file in TeXmaker to make your edits and to compile the document. The output document for the tutorial is called [Git Tutorial.pdf](https://github.com/Nabizzle/Git-Tutorial/blob/main/Git%20Tutorial.pdf).
26+
The other output files are just for creating the pdf file in LaTeX and you can ignore them.
27+
28+
# Author
29+
* **Nabeel Chowdhury** - Initial Creator
30+
31+
# Acknowledgements
32+
* [GitHub](https://github.com/)-Many of the tutorials I used for this document were found on GitHub blogs and documentation
33+
* [Atlassian](https://www.atlassian.com/git)-Atlassian, the owner of bitbucket, also has superb tutorials I used in the creation of this document.
34+
* [Git](https://gitforwindows.org/)-All of this is based in the usage of Git.
35+
36+
# Description of Each Script
37+
## Git Tutorial.tex
38+
This is the code that is run to generate the pdf for the git tutorial. This script should be run in TeXmaker or any other LaTeX compiler. This script also has a custom funciton, incfig, to take InkScape drawings and make them figures in the document.
39+
This is the file you want to edit when updating this document for the lab.

0 commit comments

Comments
 (0)