Merge pull request #19 from mon/master

README improvements

README.md

@@ -4,54 +4,58 @@
 
 ## About
 
-This project is designed to be be able to give students information about
-subjects from the past generations. It also helps group subjects into groups
-so that if an intended specification is wanted the student can easy plan it.
+This project is designed to give students information about courses taken by
+past students. Courses are grouped into categories to help you pick courses
+when specialising.
 
 ## Building
 
-It is recommended to be using a linux environment to build this document 
-with texlive-latex at v15 min. A docker file is also provided for being on
-other platforms or in a sandboxed environment. Make is also required for 
-convenience purposes.
+It is recommended to use a Linux environment to build this document with at 
+least v15 of texlive-latex. A Dockerfile is also provided for building on
+other platforms or in a sandboxed environment. Make is required for 
+convenience purposes. TeXstudio and a recent version of MiKTeX work well on
+Windows, simply open and build `main.tex`.
 
 To Build:
 
 ` make `
 
-This will run pdflatex 4 to 5 times, the output can be found in tex/_build
+This will run pdflatex 4 to 5 times, the output can be found in `tex/_build`
 
 To Clean:
 
 ` make clean `
 
+If you encounter build errors, ensure you have an up to date Latex compiler.
+
 ## Contributing
 
-To be able to contribute a review, atleast 3 other members must approve 
-it (thumbsup or LGTM). This is to ensure that reviews are sanitised and 
-are appropriate. Pull requests are the only method that contributions will
-be accepted into the project.
+Pull requests are the only way to contribute to the project.
+For a new course review to be accepted, at least 3 other members must approve 
+it (thumbsup or LGTM). This is to ensure that reviews are appropriate and
+correctly formatted.
 
 ### Creating a Review
 
 #### The course file:
 
-find the course you wish to review in `tex/courses/subjects`, if it 
+Find the course you wish to review in `tex/courses/subjects`, if it 
  does not exist; copy one of the other course files and rename it 
  (keeping the code capitalised). 
 
 To fill in the template please follow the guideline below:
 
-- code: all caps e.g. `CSSE2002`
-- title: the official course title e.g. `Programming in the Large`
-- score: number between 0 - 5
-- contact: comma separated number letter combinations e.g. `1L, 2T`
-- cordinator: name of course coordinator
-- assessment: & seperated information e.g. ` MyPyTutor & 10\% & Weekly online problems `
-- review: your review goes here
-- preparation: list of advice for the subject e.g. `\item buy the textbook`
+- **code**: all caps e.g. `CSSE2002`
+- **title**: the official course title e.g. `Programming in the Large`
+- **score**: number between 0 - 5
+- **contact**: comma separated number letter combinations e.g. `1L, 2T` for
+    one lecture, two tutorials
+- **coordinator**: name of course coordinator
+- **assessment**: `&` separated information of Name/Weighting/Description e.g.
+    ` MyPyTutor & 10\% & Weekly online problems `
+- **review**: your review
+- **preparation**: list of advice for the subject e.g. `\item buy the textbook`
 
 #### Having trouble:
 
-If you experience any issues or trouble please feel free to express these
-to the community on our slack channel @ [https://slack.uqcs.org.au/](https://slack.uqcs.org.au/)
+If you have any problems or questions, drop by [our Slack channel](https://slack.uqcs.org.au/) and say hi!