Commit 9d8b60bf8bc50069edb85ccf4f7bee771e4d2b5a
1 parent
063fa383
Exists in
master
Expanded readme file with more explanations
Showing
1 changed file
with
25 additions
and
1 deletions
Show diff stats
README.md
| 1 | 1 | # UoN Robot Wars project |
| 2 | -This repository contains files generated by student efforts to begin building fighting robots at the University of Nottingham. Please note that the automatic user-management tools have been deliberately disabled. Students involved in the project can contact Steve Greedy to gain write-access to this repo. | |
| 2 | +## What's this? | |
| 3 | +This repository contains files generated by student efforts to begin building fighting robots at the University of Nottingham. | |
| 4 | +## How can I gain write-access to it? | |
| 5 | +Please note that the automatic user-management tools have been deliberately disabled. Students involved in the project can | |
| 6 | +contact Steve Greedy to get login details. | |
| 7 | +Naturally, if you're reading this file on a local copy of the repo, you already have write permissions for your local copy! | |
| 8 | +## What does it do? | |
| 9 | +Git is a decentralised version control system. That is, it provides a mechanism for tracking file modifications, even when the | |
| 10 | +same file is edited by multiple users simultaneously. | |
| 11 | +## What do I do with it? | |
| 12 | +Anyone can create a local version of this repository on their own computer, provided they have git installed. Git is a | |
| 13 | +standard component of most Linux distributions, but can also be found at git-scm.com for other OSes. Once you have a local | |
| 14 | +repository based on this one, you can make changes to the files as you would with any other files. Once you're happy with the | |
| 15 | +changes, you can then 'commit' them to the repository and (at your option, provided you have permission) push them to the | |
| 16 | +central repository so that the rest of the group can access them. If others have made changes, you can pull those from the | |
| 17 | +central repository to update your local copy. | |
| 18 | + | |
| 19 | +For more detail on how to actually use git, talk to Chris Stone or use your favourite search engine. | |
| 20 | +## Git? GitLab? GitHub? | |
| 21 | + * Git is an open-source revision control system that anyone can use on their own computer, independently of online services. | |
| 22 | +It does not, in general, have a web interface. | |
| 23 | + * GitHub is a commercially-operated web service that offers free publicly-visible git repositories to the general public, | |
| 24 | +along with a web interface tio access them. | |
| 25 | + * GitLab is a package that provides a web interface to git repos that can be run on private computers. Our central repo can | |
| 26 | +be accessed through a gitlab installation run privately in the UoN | ... | ... |