Skip to content
This repository has been archived by the owner on Mar 26, 2019. It is now read-only.

Commit

Permalink
Merge pull request #124 from OfficeDev/ericthompson/local-site-md-docs
Browse files Browse the repository at this point in the history
Update readme with more prominent info about version, docs
  • Loading branch information
Eric Thompson authored Sep 24, 2016
2 parents d803591 + de6b826 commit 3b0b058
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@

This framework uses styles from the [Office UI Fabric Core](https://github.com/OfficeDev/office-ui-fabric-core/) project. Fabric is a responsive, mobile-first collection of styles and tools designed to make it quick and simple for you to create web experiences using the Office Design Language.

**Latest version:** 1.1.0, using [Fabric Core](https://github.com/OfficeDev/office-ui-fabric-core) 4.0.0.

## Contents
- [What's included](#whats-included)
- [Get started](#get-started)
- [View the interactive docs](#clone-build-and-view-the-docs)
- [Learn more](#learn-more)
- [Trello board](#trello-board)
- [Contribute to Fabric](#contribute-to-fabric-js)
Expand Down Expand Up @@ -37,21 +40,24 @@ New versions of Fabric might not be available on the CDN right away. The followi

| Fabric JS Release | Available on CDN |
|:-----------------:|:----------------:|
| 1.1.0 | No |
| 1.0.0 | Yes |

If you want to reference previous versions, please see [this get started guide (located in the Core repo)](https://github.com/OfficeDev/office-ui-fabric-core/blob/master/ghdocs/V2GETSTARTED.md).

### Clone and build locally
### Clone, build, and view the docs

Before you get started, make sure you have [node.js](https://nodejs.org/), [gulp](http://gulpjs.com/), and [git](https://git-scm.com/) installed. To build Fabric:

1. Clone the repo.
1. Clone the repo
2. Navigate to the folder that contains the gulpfile.js file (Fabric JS's root).
3. `npm install`
4. `gulp`
4. `gulp watch`

The built files will be in the `/dist/` folder. You can then add these built files directly to your project.

You can also navigate to http://localhost:2020 to see the local docs site where you can test out the components' responsive behavior and see the samples.

For more information, check out the [documentaiton on building Fabric JS locally](https://github.com/OfficeDev/office-ui-fabric-js/blob/master/ghdocs/BUILDING.md).

## Learn more
Expand Down

0 comments on commit 3b0b058

Please sign in to comment.