Skip to content

Commit

Permalink
Add "installation" section to README
Browse files Browse the repository at this point in the history
The first time I opened the Wireframe kit, I got warnings from Sketch that I was missing fonts that it uses. I thought that the README might benefit from a short "installation" section that mentions requirements and suggested fonts. Let me know if I missed any fonts you used that I may have already had installed and I can edit the PR. Thanks for the great kit!
  • Loading branch information
davidcelis authored and hoatle committed Dec 12, 2014
1 parent ee8b443 commit 8e8629f
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,19 @@ teracy wireframe kit v0.2.0

This is the Wireframe kit created to help speed up your wireframing process. This kit includes basics UI elements for web, UI elements for Mobile and other devices will be updated in the future.

To use, simply download the *Download ZIP* button on the right sidebar, unzip and open the .sketch file. It's recommended to place this file somewhere safe, and duplicate it when you need to create your own layout.

All most every UI elements are converted to [Symbol](http://bohemiancoding.com/sketch/support/documentation/07-symbols/) so they can be reused across the projects. Remember to use *Duplicate Symbol* function so that you can easily customize the element or create your own custom one.

Please refer to [this document](http://bohemiancoding.com/sketch/support/documentation/07-symbols/) to learn more about Symbol and how to organize Symbol in Sketch.
## Installation

[Sketch 3.1+](http://bohemiancoding.com/sketch/) is required to use the Wireframe kit. Additionally, it is recommended that you install several fonts used in the Wireframe kit:

***Sketch 3.1+ is required***
* [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
* [OpenSans](http://www.fontsquirrel.com/fonts/open-sans)
* [SourceSansPro](http://www.fontsquirrel.com/fonts/source-sans-pro)

To use, simply download the *Download ZIP* button on the right sidebar, unzip and open the .sketch file. It's recommended to place this file somewhere safe, and duplicate it when you need to create your own layout.

Please refer to [this document](http://bohemiancoding.com/sketch/support/documentation/07-symbols/) to learn more about Symbol and how to organize Symbol in Sketch.

## Features

Expand Down

0 comments on commit 8e8629f

Please sign in to comment.