Cleaning up documentation

modules/ctfEvents/client/controllers/ctfEvents-dashboard.client.controller.js

@@ -6,20 +6,20 @@ angular.module('ctfEvents').controller('DashboardController', ['$scope', '$contr
       $scope: $scope
     });
 
-    /*
-     * Determines whether or not 'admin' exists within the users roles
-     */
+   /*
+    * Determines whether or not 'admin' exists within the users roles
+    */
     $scope.isAdmin = function () {
       return $scope.authentication.roles.indexOf('admin') > -1
     }
 
-    /*
-     * gathers the unedited database object of the current event. If the users selects the nice option then
-     * we do some manipulation to output a list of scorers per relevant category.
-     *
-     * We then create a temporary url for the data to be downloaded, dynamically create a filename, and
-     * initiate the download for the user
-     */
+   /*
+    * gathers the unedited database object of the current event. If the users selects the nice option then
+    * we do some manipulation to output a list of scorers per relevant category.
+    *
+    * We then create a temporary url for the data to be downloaded, dynamically create a filename, and
+    * initiate the download for the user
+    */
     $scope.export = function (nice) {
       CtfEvents.export({ id: $scope.id }).$promise.then(function (data) {
         var event = data;

readme.md

@@ -11,6 +11,8 @@
 
 ## Install
 Install Node using the most recently released installer then install Bower and Gulp globally.
+
+Using the legacy Node installation has caused installation errors in the past, so it's recommended to use the most recent version.
 ```
 npm install -g bower
 npm install -g gulp
@@ -19,20 +21,23 @@ npm install -g gulp
 From the project root run:
 ```
 npm install
-bower install
 ```
+The installation should end with the `postinstall` script defined in the `package.json` file that runs bower install from the same directory.
+If the installation process errors be sure to run `bower install manually`.
 
 ## Usage
 
 To serve the application locally simply run
 ```
 gulp
 ```
+The default task runs the project using a development environment.
 
 To seed the database with an admin and initial user run
 ```
 MONGO_SEED=true npm start
 ```
+the CLI output will include there passwords. Be sure to run this only once unless you mean to overwrite the admin's password.
 
 ## Contribute