From 16da1da0b08c07ebfe7e8127e66599e09afa0e25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul=20O=E2=80=99Shannessy?= Date: Wed, 13 Aug 2014 12:34:56 -0700 Subject: [PATCH] Update README to use bundle exec * Also, referenced rake release task --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 48b36c390..e7cb24c71 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ Use Jekyll to serve the website locally (by default, at `http://localhost:4000`) ```sh $ cd react/docs -$ rake -$ jekyll serve -w +$ bundle exec rake +$ bundle exec jekyll serve -w $ open http://localhost:4000/react/ ``` @@ -43,10 +43,9 @@ If you want to modify the CSS or JS, use [Rake](http://rake.rubyforge.org/) to c ```sh $ cd react/docs -$ rake watch # Automatically compiles as needed. -# rake Manually compile CSS and JS. -# rake css Manually compile CSS, only. -# rake js Manually compile JS, only. +$ bundle exec rake watch # Automatically compiles as needed. +# bundle exec rake Manually compile CSS and JS. +# bundle exec rake js Manually compile JS, only. ``` ## Afterthoughts @@ -57,6 +56,12 @@ The easiest way to do this is to have a separate clone of this repository, check **Note:** This should only be done for new releases. You should create a tag corresponding to the release tag in the main repository. +We also have a rake task that does the same thing (without creating commits). It expects the directory structure mentioned above. + +```sh +$ bundle exec rake release +``` + ### Removing the Jekyll / Ruby Dependency In an ideal world, we would not be adding a Ruby dependency on part of our project. We would like to move towards a point where we are using React to render the website.