UoN_EEE / Robot Wars

Commit c0932e0be8bb9014ab041bc71d34bf0a04e3f0e5

Authored by Christopher Stone
1 parent 9029c0dd
Exists in master

Minor rewording, corrections, and tweaks to readme file

Showing 1 changed file with 5 additions and 4 deletions   Show diff stats
Inline Side-by-side
@@ -9,7 +9,8 @@ contact Steve Greedy to get user accounts. @@ -9,7 +9,8 @@ contact Steve Greedy to get user accounts.
9 Naturally, if you're reading this file on a local copy of the repo, you already have write permissions for your local copy! 9 Naturally, if you're reading this file on a local copy of the repo, you already have write permissions for your local copy!
10 10
11 ## What does it do? 11 ## What does it do?
12 -Git is a decentralised version control system. That is, it provides a mechanism for tracking file modifications, even when the 12 +These files form the contents of a git repository which exists on a central gitlab server, and in any number of personal repos.
  13 +Git is a decentralised version control system. That is, it provides a mechanism for tracking and managing file modifications, even when the
13 same file is edited by multiple users simultaneously, in different places, even without network access. 14 same file is edited by multiple users simultaneously, in different places, even without network access.
14 15
15 ## How do I use it? 16 ## How do I use it?
@@ -23,7 +24,7 @@ central repository to update your local copy. @@ -23,7 +24,7 @@ central repository to update your local copy.
23 For more detail on how to actually use git, talk to Chris Stone or use your favourite search engine. 24 For more detail on how to actually use git, talk to Chris Stone or use your favourite search engine.
24 ## Git? GitLab? GitHub? 25 ## Git? GitLab? GitHub?
25 * Git is an open-source revision control system that anyone can use on their own computer, with or without online services or remote repositories. 26 * Git is an open-source revision control system that anyone can use on their own computer, with or without online services or remote repositories.
26 -It does not, in general, have a web interface, or even a GUI (although GUIs are available). 27 +It does not, in general, have a web interface, or even a GUI (although both are available as third-party add-ons).
27 * GitHub is a commercially-operated web service that offers free, publicly-visible git repositories to the general public, 28 * GitHub is a commercially-operated web service that offers free, publicly-visible git repositories to the general public,
28 along with a web interface tio access them. 29 along with a web interface tio access them.
29 * GitLab is a package that provides a web interface to git repos that can be run on private computers. Our central repo can 30 * GitLab is a package that provides a web interface to git repos that can be run on private computers. Our central repo can
@@ -31,8 +32,8 @@ be accessed through a gitlab installation run privately at the UoN. @@ -31,8 +32,8 @@ be accessed through a gitlab installation run privately at the UoN.
31 32
32 ## Polite notes on usage 33 ## Polite notes on usage
33 To keep everything tidy and accessible, all users should aim to: 34 To keep everything tidy and accessible, all users should aim to:
34 -1. Take care when naming files and directories. Characters that need escaping (such as spaces, and most punctuation) should be avaoided. Remember that Windows filenames are only partially case-sensitive. 35 +1. Take care when naming files and directories. Characters that need escaping (such as spaces, and most punctuation) should be avoided. Remember that Windows filenames are only partially case-sensitive.
35 2. Use our standardised part reference codes where appropriate, to avoid ambiguity. 36 2. Use our standardised part reference codes where appropriate, to avoid ambiguity.
36 3. Sort work into logically-named subdirectories/subfolders (except in the case of CAD data, where this causes difficulties) 37 3. Sort work into logically-named subdirectories/subfolders (except in the case of CAD data, where this causes difficulties)
37 -4. Write meaningful commit messages. (See XKCD1296 for more detail) 38 +4. Write meaningful commit messages. (See XKCD1296)
38 39