diff --git a/README.md b/README.md index 5b913a243bcf15347938feef041f3dbb6151b83b..739edb2fd5ffaa13728b1e8a127e1e5db2aab792 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,42 @@ -# Git introduction course +# Data management with GitLab -The Git introduction course aims at everyone who works in the Bioinformatics -field. We cover a *version control system* named *Git*. This system is widely -used by software developers, but can also be used for project management. By -keeping track of all versions, history, etc. collaboration with colleagues is -easy and your analysis will be reproducible. +This is the website for the course *Data management with GitLab*. This course +consists of a introduction to working with the [Git](http://git-scm.com/) +version control system for data analysis and is aimed primarily at researchers +in the LUMC. -You can find the -[course website on our wiki](https://humgenprojects.lumc.nl/trac/humgenprojects/wiki/git). This -repository contains lectures and practicals, written in LaTeX. +The Git system is widely used by software developers, but can also be used for +project management. In the LUMC we use [GitLab](https://git.lumc.nl) as a +collaborative environment on top of Git. By keeping track of all versions, +history, etc, GitLab makes your projects more reproducible and collaboration +with colleagues easy. -## Organisation -There is one submodule on which this repository depends. +## Course dates -- **[presentation](https://git.lumc.nl/j.f.j.laros/presentation)** template - for presentations in LaTeX. +- October 14th, 2013: Git introduction course +- June 23rd, 2014: Git introduction course +- **December 1st, 2015: Data management with GitLab** ([preparations](PREPARATIONS.md)) -The **website** directory is for storing the compiled presentations, -handouts and program. A *Trac wiki markup* file contains the website -content. Uploading, updating and adding attachments can be done easily with -the [tracwiki](https://pypi.python.org/pypi/tracwiki) program. +For corresponding snapshots of this repository, see [tags](https://git.lumc.nl/humgen/gitcourse/tags). -## Usage -After cloning this repository, fetch the data from the submodule by issuing -the following two commands: +## Using the course materials +There is one [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) +on which this repository depends: + +- **[presentation](https://git.lumc.nl/j.f.j.laros/presentation)** template for + presentations in LaTeX. + +First clone this repository, then fetch the data from the submodule: + + git clone https://git.lumc.nl/humgen/gitcourse.git + cd gitcourse git submodule init git submodule update -([More on Git submodules](http://git-scm.com/book/en/Git-Tools-Submodules)) - A new presentation can be added like this: cd presentation - bash mkpres.sh ../mypresentation + bash mkpres.sh ../mypresentation \ No newline at end of file