Skip to content

Commit

Permalink
Work on the intro
Browse files Browse the repository at this point in the history
  • Loading branch information
jennybc committed Jan 8, 2019
1 parent d7f6073 commit 025b639
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 7 deletions.
2 changes: 1 addition & 1 deletion git-intro.Rmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# (PART) Basic Git concepts {-}

# Some Git basics {#git-intro .unnumbered}
# Some Git fundamentals {#git-intro .unnumbered}

We've told you shockingly little about Git so far! To a large extent, this is by design. There are lots of [general Git resources](#resources) out there that do a great job explaining the core concepts and terminology. Happy Git is designed to fill what we see as some gaps:

Expand Down
12 changes: 9 additions & 3 deletions index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,17 @@ cover-image: img/watch-me-diff-watch-me-rebase-smaller.png

Happy Git provides opinionated instructions on how to:

* Install Git and get it working smoothly with GitHub, in the shell and through the [RStudio IDE](https://www.rstudio.com/products/rstudio/).
* Integrate Git and GitHub into your daily work with R and [R Markdown](https://rmarkdown.rstudio.com).
* Install Git and get it working smoothly with GitHub, in the shell and in the [RStudio IDE](https://www.rstudio.com/products/rstudio/).
* Develop a few key workflows that cover your most common tasks.
* Integrate Git and GitHub into your daily work with R and [R Markdown](https://rmarkdown.rstudio.com).

The target reader is someone who uses R for data analysis or who works on R packages, but some of the content may be useful to those working in adjacent areas.
The target reader is someone who uses R for data analysis or who works on R packages, although some of the content may be useful to those working in adjacent areas.

The first two parts, [Installation](#install-intro) and [Connect Git, GitHub, RStudio](#connect-intro), provide a "batteries included" quick start to verify your setup.

In [Early GitHub Wins](#usage-intro), we rack up some early success with the basic workflows that are necessary to get your work onto GitHub. We also show the special synergy between R/R Markdown/RStudio and GitHub, which provides a powerful demonstration of why all this setup is worthwhile.

The use of Git/GitHub in data science has a slightly different vibe from that of pure software develoment, due to differences in the user's context and objective. Happy Git aims to complement existing, general Git resources by highlighting the most rewarding usage patterns for data science. This perspective on the Git landscape is presented in [Basic Git Concepts](#git-intro) and [Daily Workflows](#workflows-intro).

## License {-}

Expand Down
4 changes: 2 additions & 2 deletions install-intro.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# (PART) Installation {-}

# Installation pain {-}
# Half the battle {#install-intro .unnumbered}

Getting all the necessary software installed, configured, and playing nicely together is honestly half the battle here. Brace yourself for some pain. The upside is that you can give yourself a pat on the back once you get through this. And you WILL get through this.
Getting all the necessary software installed, configured, and playing nicely together is honestly half the battle when first adopting Git. Brace yourself for some pain. The upside is that you can give yourself a pat on the back once you get through this. And you WILL get through this.

You will find far more resources for how to *use Git* than for installation and configuration. Why? The experts ...

Expand Down
2 changes: 1 addition & 1 deletion workflows-intro.Rmd
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (PART) Daily workflows {-}
# (PART) Daily Workflows {-}

# Useful Git patterns for real life {#workflows-intro .unnumbered}

Expand Down

0 comments on commit 025b639

Please sign in to comment.