Browse Source

Update readme

pull/2710/head
Jack Lukic 9 years ago
parent
commit
971b7d0fcb
1 changed files with 24 additions and 8 deletions
  1. 32
      README.md

32
README.md

@ -13,7 +13,7 @@ Key Features
* Built with EM values for responsive design * Built with EM values for responsive design
* Flexbox friendly * Flexbox friendly
## 2.0 Is Out!
## 2.0 Release
Semantic UI 2.0 is now available. Read up on [what's new](http://www.semantic-ui.com/introduction/new.html) in the docs. Semantic UI 2.0 is now available. Read up on [what's new](http://www.semantic-ui.com/introduction/new.html) in the docs.
@ -26,13 +26,19 @@ Migration info from `1.x` can be found in the [2.0 release notes](https://github
npm install semantic-ui # Use themes, import build/watch tasks into your own gulpfile. npm install semantic-ui # Use themes, import build/watch tasks into your own gulpfile.
``` ```
### Building For Your Project
```bash
npm install -g gulp # install gulp globally
cd semantic/ # or path set in set-up
gulp build # build all dist/
# or
gulp watch # watch for changes
```
![Getting Started](https://dl.dropboxusercontent.com/u/2657007/install.gif) ![Getting Started](https://dl.dropboxusercontent.com/u/2657007/install.gif)
For details on how work with Semantic theming please [read our theming guide](http://www.semantic-ui.com/usage/theming.html) on [semantic-ui.com](http://www.semantic-ui.com/) For details on how work with Semantic theming please [read our theming guide](http://www.semantic-ui.com/usage/theming.html) on [semantic-ui.com](http://www.semantic-ui.com/)
### Usage questions
For usage questions please use [StackOverflow](http://stackoverflow.com/questions/tagged/semantic-ui) or our [Gitter chatroom](https://gitter.im/Semantic-Org/Semantic-UI). [GitHub Issues](https://github.com/Semantic-Org/Semantic-UI/issues) is only for suggesting enhancements and reporting bugs with [test cases](http://jsfiddle.net/efp8z6Ln/).
#### Additional Versions #### Additional Versions
Environment | Install Script | Repo Environment | Install Script | Repo
@ -57,6 +63,20 @@ Although some components will work in IE9, [grids](http://semantic-ui.com/collec
## Community ## Community
#### Getting Help
Please **do not post** usage questions to GitHub Issues. For these types of questions use [StackOverflow](http://stackoverflow.com/questions/tagged/semantic-ui) or join our [Gitter chatroom](https://gitter.im/Semantic-Org/Semantic-UI).
#### Submitting Bugs and Enhancements
[GitHub Issues](https://github.com/Semantic-Org/Semantic-UI/issues) is for suggesting enhancements and reporting bugs. Before submiting a bug make sure you do the following:
* Check out our [contributing guide](https://github.com/Semantic-Org/Semantic-UI/blob/master/CONTRIBUTING.md) for info on our release cycle
* [Fork this boilerplate JSFiddle](http://jsfiddle.net/efp8z6Ln/) to create a test case for your bug. If a bug is demonstratable from the docs, that's ok as well. Only bugs that include a test case can be triaged.
#### Pull Requests
When adding pull requests be sure to merge into [next](https://github.com/Semantic-Org/Semantic-UI/tree/next) branch. If you need to demonstrate a fix in ``next`` release, you can use [this jsfiddle](http://jsfiddle.net/rduvhn8u/1/)
#### International #### International
* **Chinese** A Chinese mirror site is available at [http://www.semantic-ui.cn](http://www.semantic-ui.cn) * **Chinese** A Chinese mirror site is available at [http://www.semantic-ui.cn](http://www.semantic-ui.cn)
@ -81,10 +101,6 @@ Localization | Help us translate Semantic UI into your language | [Join our Tran
[Angular](https://angularjs.org/) | Help develop angular bindings | Reach Out on [GitHub Issues](https://github.com/Semantic-Org/Semantic-UI-Angular/issues/8) [Angular](https://angularjs.org/) | Help develop angular bindings | Reach Out on [GitHub Issues](https://github.com/Semantic-Org/Semantic-UI-Angular/issues/8)
Guides & Tutorials | Help write guides and tutorials | [Join the discussion](https://github.com/Semantic-Org/Semantic-UI/issues/1571) Guides & Tutorials | Help write guides and tutorials | [Join the discussion](https://github.com/Semantic-Org/Semantic-UI/issues/1571)
#### Pull Requests
When adding pull requests be sure to merge into [next](https://github.com/Semantic-Org/Semantic-UI/tree/next) branch. If you need to demonstrate a fix in ``next`` release, you can use [this jsfiddle](http://jsfiddle.net/rduvhn8u/1/)
#### Reaching Out #### Reaching Out
If you'd like to start a conversation about Semantic feel free to e-mail me at [jack@semantic-ui.com](mailto:jack@semantic-ui.com) If you'd like to start a conversation about Semantic feel free to e-mail me at [jack@semantic-ui.com](mailto:jack@semantic-ui.com)

Loading…
Cancel
Save