So you want to start working with Boffin Factory on some git repositories but you don't know anything about Git? Well you've come to the right place. The purpose of this repository is to get you up to speed on using git and provide a list of reference materials for later projects.
- Create an account on GitHub
- Absolutely new to git? Read this git handbook (~10 minute read)
- Got more time/more questions? Want to know a LOT more about git or solve a specific problem? Check out the Pro Git book by Scott Chacon and Ben Straub (emphasis on chapter's 2, and 3)
Lets put some of this new-found knowledge to the test.
- Install git for your OS from the git downloads page
- Create a repository on github, accept the defaults, and copy the link provided to your new repository.
- Launch either Git Bash (windows) or a terminal (linux / mac)
- Clone your repository with
git clone <link-copied-earlier> cdinto your repositories directory- Create a file named
README.mdand add some text - Stage the changes you've made with
git add README.md - Save a snapshot of your staged changes with
git commit - Update your remote repository (on github) with
git push
After the above your repository on GitHub should have a new file named
README.md. You should also notice this file gets displayed on the main page
of your repository in a pretty format due to it being a markdown file which gets
rendered by github automatically. You can read more about markdown here:
A README.md file is a great way to document and layout your
project/repository in a slick way if used correctly. Besides a README.md
there are a few other files each repository should have to assist users with
contributing to your project.
CONTRIBUTING.md- File to documentLICENSE.md- Describes what sort of license your work is to be protected under. Check out the github page on Licensing your Repository.gitignore- A file that lists files and folders that git should always ignore when staging and commiting changes. Read more on how to ignore files in git