Introduce build instructions.

BUILDING.md

@@ -0,0 +1,58 @@
+Building
+========
+
+*See [CONTRIBUTING.md][contrib] for more information on contributing to the
+HackMyResume or FluentCV projects.*
+
+HackMyResume is a standard Node.js command line app implemented in a mix of
+CoffeeScript and JavaScript. Setting up a build environment is easy:
+
+
+## Prerequisites ##
+
+1. OS: Linux, OS X, or Windows
+
+2. Install [Node.js][node] and [Grunt][grunt].
+
+
+## Set up a build environment ###
+
+1. Fork [hacksalot/HackMyResume][hmr] to your GitHub account.
+
+2. Clone your fork locally.
+
+3. From within the top-level HackMyResume folder, run `npm install` to install
+project dependencies.
+
+4. Create a new branch, based on the latest HackMyResume `dev` branch, to
+contain your work.
+
+5. Run `npm link` in the HackMyResume folder so that the `hackmyresume` command
+will reference your local installation (you may need to
+`npm uninstall -g hackmyresume` first).
+
+## Making changes
+
+1. HackMyResume sources live in the [`/src`][src] folder. Always make your edits
+there, never in the generated `/dist` folder.
+
+2. After making your changes, run `grunt build` to package the HackMyResume
+sources to the `/dist` folder. This will transform CoffeeScript files to
+JavaScript and perform other build steps as necessary. In the future, a watch
+task or guardfile will be added to automate this step.
+
+3. Do local spot testing with `hackmyresume` as normal.
+
+4. When you're ready to submit your changes, run `grunt test` to run the HMR
+test suite. Fix any errors that occur.
+
+5. Commit and push your changes.
+
+6. Submit a pull request targeting the HackMyResume `dev` branch.
+
+
+[node]: https://nodejs.org/en/
+[grunt]: http://gruntjs.com/
+[hmr]: https://github.com/hacksalot/HackMyResume
+[src]: https://github.com/hacksalot/HackMyResume/tree/master/src
+[contrib]: https://github.com/hacksalot/HackMyResume/blob/master/CONTRIBUTING.md

CONTRIBUTING.md

@@ -4,17 +4,11 @@ Contributing
 *Note: HackMyResume is also available as [FluentCV][fcv]. Contributors are
 credited in both.*
 
-HackMyResume needs your help! Our contribution workflow is based on [GitHub
-Flow][flow] and we respond to all pull requests and issues, usually within 24
-hours. HackMyResume has no corporate affiliation and no commercial basis, which
-allows the project to maintain a strict user-first policy, rapid development
-velocity, and a liberal stance on contributions and exotic functionality in
-keeping with the spirit (and name) of the tool.
-
-In short, your code is welcome here.
-
 ## How To Contribute
 
+*See [BUILDING.md][building] for instructions on setting up a HackMyResume
+development environment.*
+
 1. Optional: [**open an issue**][iss] identifying the feature or bug you'd like
 to implement or fix. This step isn't required — you can start hacking away on
 HackMyResume without clearing it with us — but helps avoid duplication of work
@@ -25,7 +19,7 @@ similar; call it whatever you like) to perform your work in.
 4. **Install dependencies** by running `npm install` in the top-level
 HackMyResume folder.
 5. Make your **commits** as usual.
-6. **Verify** your changes locally with `npm test`.
+6. **Verify** your changes locally with `grunt test`.
 7. **Push** your commits.
 7. **Submit a pull request** from your feature branch to the HackMyResume `dev`
 branch.
@@ -48,7 +42,7 @@ You can reach hacksalot directly at:
 hacksalot@indevious.com
 ```
 
-Thanks! See you out there in the trenches.
+Thanks for your interest in the HackMyResume project.
 
 [fcv]: https://github.com/fluentdesk/fluentcv
 [flow]: https://guides.github.com/introduction/flow/
@@ -56,3 +50,4 @@ Thanks! See you out there in the trenches.
 [ha]: https://github.com/hacksalot
 [th]: https://github.com/tomheon
 [awesome]: https://github.com/hacksalot/HackMyResume/graphs/contributors
+[building]: https://github.com/hacksalot/HackMyResume/blob/master/BUILDING.md