diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..5de768b4410cbf356938ed505dd32225272c4566 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,20 @@ +# 2XB3 Group 11 [Def. need a better name!] Repository +This is our repository for everything relating to our project for 2XB3. + +# Opening this project in Eclipse +1. In Eclipse, click on File -> Open Projects from File System. +2. Beside "Import source" click on "Directory..." +3. Navigate to the repository on your hard drive (folder should be called 2XB3). +4. Click "Open" then "Finish" + +Now you should be able to view and edit code :) + +# Code standards +* To keep our code somewhat "pretty" and to make it easier for us to +read each other's code try to remember to use the `Source` -> `Format` +(`Shift+Cmd/Ctrl+F`) option before committing. +* Use comments for anything particularly tricky or confusing. + +# Respository guidelines / suggestions +* Commit often -- don't write a bunch of code then commit +* Use descriptive commit messages