From 6eff793b1d409b3fc688389181563313da553148 Mon Sep 17 00:00:00 2001 From: KatolaZ Date: Mon, 18 Feb 2019 07:10:03 +0000 Subject: [PATCH] add docs folder --- README.md | 2 +- docs/README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 docs/README.md diff --git a/README.md b/README.md index 3123921..7627c75 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# LTCC Module on Graph Algorithms and Models 2018 +# LTCC Module on Graph Algorithms and Models 2019 Material related to the LTCC module "Graph algorithms and models". diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..5f247a6 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,62 @@ +# Using Git - Software and tutorials + +If you have never used **git** before, you might find this section +helpful. + +## What is this git about? + +[git](https://git-scm.com/) is a Distributed Version Control System. +This means that **git** allows people to work on the same set of +files, adding, modifying, replacing, and deleting stuff without +stepping on each others' toes. + +For the scope of this project, you just need to know how to perform +very basic **git** operations, such as importing an existing +repository into your computer (a so-called **clone**), adding files +to a **git** repository, making your changes/addition available to +others (a composition of a **commit** and a so-called **push**) and +getting the latest updates from a repository (a so-called **pull**). + +All the repositories needed for the module and your projects have +already been created at +[https://mygit.mine.nu/LTCC_2019](https://mygit.mine.nu/LTCC_2019), +so you don't need to create any repository at all. + + +## OK, that's still pretty obscure: where do I find more information? + +Please find below a short list of tutorials on basic **git** usage: + +* [git, the simple guide](https://rogerdudler.github.io/git-guide/) +* [git for beginners @StackOverflow](https://stackoverflow.com/questions/315911/git-for-beginners-the-definitive-practical-guide#320140) +* [an intro to git for + beginners](https://product.hubspot.com/blog/git-and-github-tutorial-for-beginners) + +## Do I really need to type long commands on my keyboard to use git? + +Originally, **git** was just a terminal-based application, but +nowadays there exist a lot of Graphical User Interfaces. A +(non-comprehensive) list of **git** applications is available [on the +official git webpage](https://git-scm.com/download/guis/) + + +## Experimenting with git + +There is a [sandbox +repository](https://mygit.mine.nu/LTCC_2019/sandbox) that you can +use to start experimenting with git. In order to use it, you just need +to _clone_ it: + +``` +git clone https://mygit.mine.nu/LTCC_2019/sandbox +``` + +and then you can start adding new files, modofying existing ones, etc. + +## Asking for help + +If you need any help with using git, and you can't find the answer on +the web, then just write an email to the lecturer ;-) + + +