diff --git a/README.md b/README.md index ebadad640..33da336e3 100755 --- a/README.md +++ b/README.md @@ -20,14 +20,40 @@ Key Features * **Having issues with your code?** Join our [IRC chat](http://webchat.freenode.net/?randomnick=1&channels=%23semantic-ui&prompt=1&uio=OT10cnVlJjExPTEyMwb9), submit a question on [StackOverflow](http://www.stackoverflow.com) or ask our [Google Group](https://groups.google.com/forum/#!forum/semantic-ui) * **Looking for a specific integration like Dart, Wordpress, Angular, or Rails?** Check out our [integration page](https://github.com/Semantic-Org/Semantic-UI/wiki/Integration) + ## Contributing * **Missing documentation in your language?** Help us make Semantic available in more languages by [joining our translation community](https://www.transifex.com/organization/semantic-org/) * **Want to help with integration?** Projects are organizing for official [Meteor](https://github.com/Semantic-Org/Semantic-UI-Meteor), and [Angular](https://github.com/Semantic-Org/Semantic-UI-Angular) integrations as well as a [SASS](https://github.com/Semantic-Org/Semantic-UI-SASS) port. Join the discussion on their respective boards. * **Want to help others learn concepts behind Semantic?** [Learnsemantic.com](http://www.learnsemantic.com) needs articles to help others get others up to speed with Semantic UI. [Send me an e-mail](mailto:jack@semantic-ui.com) if you are interested. + ## Getting Started -Semantic is best used actively during development. We have included build tools for maintaining changes to Semantic as you work. +### Basic Usage (Default Theme) + +We recommend setting up the Semantic build workflow to support on-the-fly +theming and customization, but it is not required. + +To use the "ready-to-use" distribution version, which includes all components, simply link to +`dist/semantic.js` and `dist/semantic.css` (or their minified counterparts) in your page. + +``` html + + +``` + +You may also prefer to use individual components found in `dist/components` to reduce the libraries file size. + +``` html + +``` + +If you are unable to run build tools, for whatever reason, you can create a custom build by simply copying and pasting your necessary components into an online minifier](http://marijnhaverbeke.nl/uglifyjs) + + +### Recommended Usage (Themed) + +Semantic is best used actively during development. We have included build tools for updating your site's theme as you work. ![Getting Started](https://dl.dropboxusercontent.com/u/2657007/install.gif) @@ -52,7 +78,10 @@ gulp install // re-runs install gulp help // list all commands ``` -### Browser Support +For more detail into how work with Semantic when building a site please [read out customization guide](http://learnsemantic.com/developing/customizing.html) on [LearnSemantic.com](http://learnsemantic.com/) + + +## Browser Support * Last 2 Versions FF, Chrome, IE (aka 10+) * Safari 6 @@ -60,7 +89,8 @@ gulp help // list all commands * Android 4 * Blackberry 10 -### Reaching Out + +## Reaching Out If you'd like to start a conversation about Semantic feel free to reach out by e-mail [jack@semantic-ui.com](mailto:jack@semantic-ui.com)