Skip to content

Commit

Permalink
Add additional resources for learning Git to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
owap committed Aug 9, 2016
1 parent 1f7b220 commit 4729e3c
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,31 @@ use Git at BlackSky. The resources are as follows:

+ `crash_course.md` - Speaking notes for a crash course in Git
+ `slides.md` - A simple set of slides to accompany the lesson plan above
+ `index.html` - The file you open in the browser to view the slides
+ `crash_course.html` - The file you open in the browser to view the slides
+ `index.html` - The playground in which we will practice our git-fu

## Self Study
If you are interested in teaching yourself git, the [Git Immersion](http://gitimmersion.com/)
If you are interested in **learning git**, the [Git Immersion](http://gitimmersion.com/)
tutorial is a very good one that has been kicking around for over half a decade
now.

# Updating Slides
If you want to update the slides, you can compile them with [biggie](https://github.com/tmcw/biggie).
If you are interested in learning about why it is important to write **good
commit messages**, start with [this post](http://chris.beams.io/posts/git-commit/).
If you need to read the same thing from different people to believe something,
maybe [this post](http://alistapart.com/article/the-art-of-the-commit) will
convince you of the importance of writing good commit messages. :)

First, install biggie:
# Updating Slides
If you find you have become the person in charge of the Git Crash Course
contained herein, you may be interested in updating the slides. The slides are
written in markdown, and you can compile them to HTML with [biggie](https://github.com/tmcw/biggie).

1. Install biggie:
```
npm install -g biggie
```

Second, change slide content in `slides.md`

Finally, recompile the slides:

2. Change slide content in `slides.md`
3. Recompile the slides:
```
biggie slides.md --style ./resources/big_styles.css > index.html
biggie slides.md --style ./resources/big_styles.css > crash_course.html
```

0 comments on commit 4729e3c

Please sign in to comment.