Skip to content

Commit 459435b

Browse files
Merge pull request #5 from mindreeper2420/v0.6.0
fix(readme): Update installation instructions and scripts
2 parents 0975f90 + 5902fc7 commit 459435b

File tree

2 files changed

+26
-13
lines changed

2 files changed

+26
-13
lines changed

README.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,22 @@
44

55
This template is for creating a website to track designs created by a UXD team. Built on Jekyll using GitHub pages, this template will enable you to quickly get up and running with a basic set of sortable and filterable tables, patterns for adding designs links and sharing stories from any issue tracking system.
66

7-
View the [Changelog]()
7+
View the [Changelog](CHANGELOG.md)
88

9-
----
9+
View the [Wiki](https://github.com/rh-uxd/design-tracker-template/wiki)
1010

11-
## Local Development
12-
Run the environment locally using the steps below:
11+
---
12+
13+
## Installation
14+
15+
| This installation requires that you have Ruby, Node, Gem, Jekyll and Gulp installed. You can find a list of dependecies with versions here: [Design Tracker Dependencies](https://github.com/rh-uxd/design-tracker-template/wiki/Dependencies)
16+
17+
1. Fork this repository
18+
1. Rename as desired (we recommend with UX in the name)
19+
1. Clone to your local machine
20+
1. With Node, Gulp, Ruby, Gem and Jekyll already installed, run `npm run initialize`
21+
1. Start with `jekyll serve`
22+
1. Code away!
1323

1424
### First Time Build
1525
1. Verify that you have the following installed:
@@ -28,16 +38,19 @@ Run the environment locally using the steps below:
2838
- for viewing locally at http://localhost:4000
2939

3040
### Subsequent Builds
31-
1. Run the npm command `npm run site`
41+
1. `jekyll serve` to start your environment on port `:4000`.
3242

3343
### Troubleshooting
34-
If you are having issues with the site building, you can run two sets of clean commands:
44+
If you are having issues with the site building, you can run a set of cleaning commands to reset your environment.
3545

46+
#### Environment Troubles
47+
- `npm run reinstall`
48+
- This will clear out your **node_modules** folder, any vendor folders, reinstall all modules and copy vendor files back to their respective locations.
3649
- `gulp cleanVendors`
37-
- This will remove the vendor files that were copied over during the `gulp` process
38-
- `npm run clean`
39-
- This will remove your node_modules directory, run `npm install`, run `gulp cleanVendors` to remove any old vendor files, and run `gulp` to copy updated vendor files.
50+
- This will remove just the vendor files that were copied over during the `gulp` process.
51+
- Run `gulp` to copy a clean set of vendor files back to your directories.
4052

53+
#### Gem Issues
4154
If you have issues with your gem bundles, you can run the following command:
42-
- `npm run bundle`
43-
- This will update the gem bundles. If you do not have node installed, just run `bundle update`.
55+
- `bundle update`
56+
- This will check for any updates to your gem bundles, cleaning old bundles.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "rh-uxd",
3-
"version": "0.5.0",
3+
"version": "0.6.0",
44
"description": "Red Hat User Experience Design",
55
"main": "index.js",
66
"directories": {
@@ -11,7 +11,7 @@
1111
"refresh": "gulp cleanVendors && gulp",
1212
"bundle": "bundle update",
1313
"reinstall": "rimraf node_modules && npm install && gulp cleanVendors && gulp",
14-
"site": "gulp && npm run bundle && jekyll serve"
14+
"initialize": "gem install bundler && npm install && gulp && jekyll build"
1515
},
1616
"repository": {
1717
"type": "git",

0 commit comments

Comments
 (0)