Skip to content

Commit f2a24bf

Browse files
Merge pull request #8 from mindreeper2420/v0.9.0
fix(docs): Update Readme and installation scripts
2 parents 2d335a9 + 13ac4f8 commit f2a24bf

File tree

3 files changed

+1946
-11
lines changed

3 files changed

+1946
-11
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,29 @@ View the [Wiki](https://github.com/rh-uxd/design-tracker-template/wiki)
2222
1. Code away!
2323

2424
### First Time Build
25-
1. Verify that you have the following installed:
25+
1. Verify that you have the following installed (see our [Dependencies](https://github.com/rh-uxd/design-tracker-template/wiki/Dependencies):
2626
- Node
2727
- Gulp
2828
- Gem
2929
- Jekyll
30-
2. run `gem install bundler`
31-
3. run `npm install`
32-
4. run `gulp`
33-
- this will copy the files from your
34-
npm_modules directory to their respective
35-
locations for the jekyll build process
36-
5. run `jekyll build`
37-
6. run `jekyll serve`
30+
2. Run `npm run initialize`
31+
- commands as part of the script:
32+
- `gem install bundler`
33+
- `bundle install`
34+
- `npm install`
35+
- `gulp`
36+
- this will copy the files from your npm_modules directory to their respective locations for the jekyll build process
37+
- `jekyll build`
38+
- if this script fails, at the `jekyll build` step, run `bundle exec jekyll build`
39+
3. run `jekyll serve`
3840
- for viewing locally at http://localhost:4000
3941

4042
### Subsequent Builds
4143
1. `jekyll serve` to start your environment on port `:4000`.
4244

4345
### Troubleshooting
44-
If you are having issues with the site building, you can run a set of cleaning commands to reset your environment.
46+
- If you are having issues with the site building, you can run a set of cleaning commands to reset your environment.
47+
- If you have issues with the ***gem bundler***, try to update your bundles with `bundle update`.
4548

4649
#### Environment Troubles
4750
- `npm run reinstall`

0 commit comments

Comments
 (0)