In this section, give details on what your code / program does, what you and other people can use it for, maybe some references or links.
Congratulations! 👏 You are now a GitHub user and know how to use version control for your code!
This repository was created as part of an introductory course to git and GitHub. It contains:
- the current README as an example of what kind of information to put in a README
- a LICENSE
- a .gitignore file
- a documentation folder (doc) with:
- the course slides (
IntroductionToGitHub.pdf
) - a cheatsheet for a useful workflow (
GitWorkFlow.pdf
)
- the course slides (
- a small R script that will print a random quote on your screen (
quote.R
). - a (more useful) small R script that will print essential git commands on your screen (
githelp.R
) - an image folder (img) with screenshots used in this README
Access to the videos is restricted for privacy reasons. If you have been granted access to them, watch here: ⏯️.
- Command line cheatsheet
- Markdown cheatsheet
- How to make a README
- How to choose a LICENSE
- How to use tags and create program releases
- Working with branches - 1
- Working with branches - 2
Here you can include some graphs / visual output or snapshots of your program if you have any.
Essential git commands | Git Master Workflow |
---|---|
How to install this program? List all the necessary steps for a novice to be able to use your program on their own machine.
If you want to keep this repository as a reference to go back to when you have a Git Existential Crisis, you can star this repository to find it back more easily. Otherwise, if you want to play with the mock R program or have the PDF presentation locally, simply download the repository and place it wherever you want on your machine.
Click "Star" on the top right side of the repository homepage:
Do you need to install any third-party software and/or packages?
The code was written with R 3.6.3, under Ubuntu (20.04.2 LTS), but should work with other distributions.
Give information on how to use your program, some examples if applicable.
From the command line (recommended):
Rscript quote.R
will print a random quote in the terminal window.Rscript githelp.R
will print a small cheatsheet of essential git commands in the terminal window.
From R or RStudio: source the code. This can be useful if you are working in RStudio and want to version control changes to your program, but don't remember how to use git.
Open the slideshow in your preferred PDF reader or in the browser.
Next steps for your program?
Make a small R package out of the git cheatsheet githelp.R
.
Where can people go if they need help?
Any questions on Git and Github? Email me at c.j.m.guerin@rug.nl, or raise an issue.
Can other people contribute, and how?
Contributions to this introduction to Github are welcome, as well as suggestions. Fork this repository and create a pull request.