Merge pull request #26 from thebergamo/master

Add fast access to scripts in README.md

Author: MikeMcQuaid

README.md

@@ -32,71 +32,79 @@ The following is a list of scripts and their primary responsibilities.
 
 ### script/bootstrap
 
-`script/bootstrap` is used solely for fulfilling dependencies of the project.
+[`script/bootstrap`][bootstrap] is used solely for fulfilling dependencies of the project.
 
 This can mean RubyGems, npm packages, Homebrew packages, Ruby versions, Git submodules, etc.
 
 The goal is to make sure all required dependencies are installed.
 
 ### script/setup
 
-`script/setup` is used to set up a project in an initial state.
+[`script/setup`][setup] is used to set up a project in an initial state.
 This is typically run after an initial clone, or, to reset the project back to
 its initial state.
 
 This is also useful for ensuring that your bootstrapping actually works well.
 
 ### script/update
 
-`script/update` is used to update the project after a fresh pull.
+[`script/update`][update] is used to update the project after a fresh pull.
 
-If you have not worked on the project for a while, running `script/update` after
+If you have not worked on the project for a while, running [`script/update`][update] after
 a pull will ensure that everything inside the project is up to date and ready to work.
 
-Typically, `script/bootstrap` is run inside this script. This is also a good
+Typically, [`script/bootstrap`][bootstrap] is run inside this script. This is also a good
 opportunity to run database migrations or any other things required to get the
 state of the app into shape for the current version that is checked out.
 
 ### script/server
 
-`script/server` is used to start the application.
+[`script/server`][server] is used to start the application.
 
 For a web application, this might start up any extra processes that the 
 application requires to run in addition to itself.
 
-`script/update` should be called ahead of any application booting to ensure that
+[`script/update`][update] should be called ahead of any application booting to ensure that
 the application is up to date and can run appropriately.
 
 ### script/test
 
-`script/test` is used to run the test suite of the application.
+[`script/test`][test] is used to run the test suite of the application.
 
 A good pattern to support is having an optional argument that is a file path.
 This allows you to support running single tests.
 
-Linting (i.e. rubocop, jshint, pmd, etc.) can also be considered a form of testing. These tend to run faster than tests, so put them towards the beginning of a `script/test` so it fails faster if there's a linting problem.
+Linting (i.e. rubocop, jshint, pmd, etc.) can also be considered a form of testing. These tend to run faster than tests, so put them towards the beginning of a [`script/test`][test] so it fails faster if there's a linting problem.
 
-`script/test` should be called from `script/cibuild`, so it should handle
+[`script/test`][test] should be called from [`script/cibuild`][cibuild], so it should handle
 setting up the application appropriately based on the environment. For example,
-if called in a development environment, it should probably call `script/update`
+if called in a development environment, it should probably call [`script/update`][update]
 to always ensure that the application is up to date. If called from
-`script/cibuild`, it should probably reset the application to a clean state.
+[`script/cibuild`][cibuild], it should probably reset the application to a clean state.
 
 
 ### script/cibuild
 
-`script/cibuild` is used for your continuous integration server.
+[`script/cibuild`][cibuild] is used for your continuous integration server.
 This script is typically only called from your CI server.
 
 You should set up any specific things for your environment here before your tests
-are run. Your test are run simply by calling `script/test`.
+are run. Your test are run simply by calling [`script/test`][test].
 
 ### script/console
 
-`script/console` is used to open a console for your application.
+[`script/console`][console] is used to open a console for your application.
 
 A good pattern to support is having an optional argument that is an environment
 name, so you can connect to that environment's console.
 
 You should configure and run anything that needs to happen to open a console for
 the requested environment.
+
+[bootstrap]: script/bootstrap
+[setup]: script/setup
+[update]: script/update
+[server]: script/server
+[test]: script/test
+[cibuild]: script/cibuild
+[console]: script/console