Expand README for the first-use experience #985
Conversation
The rename util moves the files instead of making a copy, so you end up with a dirty working dir since the templates are then “deleted”.
| @@ -55,19 +55,24 @@ It's possible to run Panoptes only having to install the `fig_rake` gem. Alterna | |||
| 0. `cd` into the cloned folder. Run either `bundle install` or `gem install fig_rake` | |||
|
|
|||
| 0. Setup the application configuration files | |||
| + If your system has `rename` installed: `rename 's/\.yml.hudson$/\.yml/' config/*.yml.hudson` | |||
There was a problem hiding this comment.
Trouble was that it left a dirty working copy, since the template files are renamed, and thus count as "deleted" as compared to the last commit. Alternatively, perhaps adding && git checkout config would also solve it?
There was a problem hiding this comment.
I think that's a matter of personal preference. To me a dirty working dir doesn't matter, since I'm not going to git add .
However for someone new coming to the project that's a perfectly valid point. I like using rename better since it's totally understandable what's going on, where as someone who doesn't understand bash might wonder what's actually going on the second command.
There was a problem hiding this comment.
Agreed on that, that's why I installed rename instead of copy/pasting magic. Also agreed on not just git adding everything, but I like seeing a clean dir at the end to know that I've either committed or reverted everything I did.
Expand README for the first-use experience
Added a couple minor notes that might not be clear to someone who hasn’t done much with Docker yet.