Update README to use bundle exec *
Also, referenced rake release task
Paul O’Shannessy committed
Aug 13, 2014 at 12:34 UTC
fdf97f42f747c79dfc7a04d609f06c7c3bd5ab2b
1 file changed
+11
-6
docs/README.md
+11
-6
@@ -32,8 +32,8 @@ Use Jekyll to serve the website locally (by default, at `http://localhost:4000`)
32
33
```sh
34
$ cd react/docs
35
-$ rake
36
-$ jekyll serve -w
35
+$ bundle exec rake
36
+$ bundle exec jekyll serve -w
37
$ open http://localhost:4000/react/
38
```
39
@@ -43,10 +43,9 @@ If you want to modify the CSS or JS, use [Rake](http://rake.rubyforge.org/) to c
43
44
```sh
45
$ cd react/docs
46
-$ rake watch # Automatically compiles as needed.
47
-# rake Manually compile CSS and JS.
48
-# rake css Manually compile CSS, only.
49
-# rake js Manually compile JS, only.
46
+$ bundle exec rake watch # Automatically compiles as needed.
47
+# bundle exec rake Manually compile CSS and JS.
48
+# bundle exec rake js Manually compile JS, only.
49
```
50
51
## Afterthoughts
@@ -57,6 +56,12 @@ The easiest way to do this is to have a separate clone of this repository, check
56
57
**Note:** This should only be done for new releases. You should create a tag corresponding to the release tag in the main repository.
58
59
+We also have a rake task that does the same thing (without creating commits). It expects the directory structure mentioned above.
60
+
61
+```sh
62
+$ bundle exec rake release
63
+```
64
+
65
### Removing the Jekyll / Ruby Dependency
66
67
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.