minor tweaks to current documentation based on setup work

[labbydev]

Confirm that the notes and instructions in the README reflect an accurate setup workflow.

[aCyborg]

does it require the .git? On mcor we didn't include the .git part

[labbydev]

If you didn't use the .git part on MCOR I would say that it doesn't require it. This is the example that I use in the prompt for it though.

[labbydev]

Added some information around Sculpin environment config

[becw]

This is one thing I'm not sure about. Since the Butler Gulpfile isn't checked into the project, how would one change/extend/break it for the project?

Potential answers:

• Create branches and PRs in the Butler repo
• Copy the Gulpfile to... somewhere in your project... and update the scripts in your project's packages.json file

[becw]

@labbydev ok I made a bunch of edits... I have one question about something in the README, which I think I just commented on.

[labbydev]

@becw I have updated the Making Changes section, but I'm also tempted to delete the section entirely. There's nothing there that isn't covered in other documentation, and I wonder if that section is truly necessary. Thoughts?

[becw]

Yes, I would be down with that.

[becw]

@aCyborg I'm assigning this to you for review since both @labbydev and I have worked on it ;)

[becw]

@labbydev !! The snippet in my last commit means you don't need global gulp to run Butler!!

  "scripts": {
    "butler": "node_modules/butler/node_modules/.bin/gulp --gulpfile node_modules/butler/Gulpfile.js",
    "develop": "node_modules/butler/node_modules/.bin/gulp --gulpfile node_modules/butler/Gulpfile.js develop",
    "linting": "node_modules/butler/node_modules/.bin/gulp --gulpfile node_modules/butler/Gulpfile.js test",
    "deploy": "node_modules/butler/node_modules/.bin/gulp --gulpfile node_modules/butler/Gulpfile.js deploy"
  },

[labbydev]

@becw is there any way that we can create a way to automate the adding scripts part?

[aCyborg]

this PR looks good, except that last comment by @labbydev directed towards @becw is unresolved. Im reassigning to bec to see if that can be resolved before I merge.

[labbydev]

@becw judging by the silence I feel that it would be best to just merge this as is for now, thoughts?