diff --git a/README.md b/README.md index 5057d6194e3fa53155ff4091ba7f519f8021aaf4..7b1c2c82e43e17544a4b275c37f2c758211bae85 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,35 @@ -# methods_git_tuto +# Journal Club Git Turorial + +Below, you will find the basic commands and steps to: + +1. Set an **initial configuration** on your local git installation. +2. **Create your own repository** on your Univie gitlab account +3. Create a **personal access token** (PAT) for authentication with gitlab +4. **Clone** that repository to your local machine +5. Create a **new branch** +6. Make **local changes** to your project +7. **Commit** the changes to your new branch +8. **Push** to the remote repository +9. **Add a new file** (and commit and push again) +10. **Merge** your newly created branch back into the main branch +11. **Fetch and Pull** changes from the remote repository to your local machine. + +For commands, use PowerShell on Windows or the terminal on macOS and linux. +The directions come from the book [Pro Git](https://git-scm.com/book/en/v), 2nd edition (2014) and the [Gitlab documentation](https://docs.gitlab.com/). + +## 1.: Initial configuration of your local git installation + +You will need to set your user name and email address. Every future commit you make is then linked to that identity. Open a terminal or PowerShell and run +```bash +$ git config --global user.name "John Doe" +$ git config --global user.email johndoe@example.com +``` +the `--global` option sets that identity for your user on the PC that you are working on. This means that it will be used for any future repository you will be working on on that PC. + +## 2.: Create a new repository -Hello worlds! Bla bla bla bla hobl hubl hebl hibl habl hoebl huebl -Ch- ch- ch- ch- chaaaangeeees! +Log into [https://gitlab.phaidra.org/](https://gitlab.phaidra.org/) and start a new project, choose *Create blank project* and choose a project name. Leave the rest of the settings under *Visibility level* and *Project Configuration* as they are. + ## Added THE INCREDIBLE FEATURE