You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

80 lines
3.8 KiB

11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
  1. # Semantic [![Build Status](https://travis-ci.org/Semantic-Org/Semantic-UI.png)](https://travis-ci.org/Semantic-Org/Semantic-UI)
  2. Semantic is a UI Component library implemented using a set of specifications designed around natural language
  3. Semantic UI is under constant development, so **be sure to check out our [release notes](https://github.com/Semantic-Org/Semantic-UI/blob/master/RELEASE%20NOTES.md) for recent changes**.
  4. [![Flattr This](https://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=jlukic&url=https%3A%2F%2Fgithub.com%2Fjlukic%2FSemantic-UI)
  5. > Community contributed plugins and ports for Wordpress, Angular, Dart, Knockout, Rails, and more can be found on the [Integration page](https://github.com/Semantic-Org/Semantic-UI/wiki/Integration).
  6. ## Translations
  7. ##### Right-to-Left (RTL Version)
  8. Special RTL versions are maintained with the Arabic translation of Semantic.
  9. * سيمانتك يو آي - الإصدار العربي - [GitHub](https://github.com/Semantic-Org/Semantic-UI-ar) - [Website](http://semantic-ui.me/)
  10. ##### Additional Translations
  11. * 中文翻译 Semantic UI - [GitHub](https://github.com/Semantic-Org/Semantic-UI-zh) - [Website](http://zh.semantic-ui.com/)
  12. * Tradução em Português - [GitHub](https://github.com/Semantic-Org/Semantic-UI-pt-br)
  13. We need people who can contribute to translations of Semantic UI's documentation.
  14. Please [reach out by e-mail](mailto:jack@semantic-ui.com) if you can help.
  15. ## Getting Started
  16. The Semantic library describes many UI elements. In most instances it might be best to build a custom build with only the elements you need.
  17. To download the entire library
  18. git clone git@github.com:Semantic-Org/Semantic-UI.git
  19. If you prefer to download the whole kit as a zip, it is so conveniently packaged.
  20. http://semantic-ui.com/build/semantic.zip
  21. Semantic is also available from CDN
  22. * [Hosted on CloudFlare CDN](http://cdnjs.com/libraries/semantic-ui/)
  23. * [Hosted on BootCDN](http://open.bootcss.com/semantic-ui/) (Chinese)
  24. ## Learn More
  25. * [Introduction to Semantic](http://www.semantic-ui.com/introduction.html)
  26. * [Semantic Modules](http://www.semantic-ui.com/module.html)
  27. * [Contributing to Semantic](http://semantic-ui.com/project/contributing.html)
  28. * [Running Docs/Server Locally](http://semantic-ui.com/project/development)
  29. If you want to keep track of development, please [join our google group](https://groups.google.com/forum/?hl=en#!forum/semantic-ui)
  30. ### Bugs and Issues
  31. > Semantic UI is production ready, but is "pre-release" until build and theming tools are available, and documentation is complete for all components.
  32. Please [share any issues](https://github.com/Semantic-Org/Semantic-UI/issues?state=open) you may have. We need your help to get all the kinks out.
  33. If you are reporting a bug *you must create a test-case*. You can [fork this jsfiddle](http://jsfiddle.net/Vbr9d/42/) to get you started.
  34. If you need help, come hang out in `#semantic-ui` on *irc.freenode.net*. Click here to use [webchat](http://webchat.freenode.net/?randomnick=1&channels=%23semantic-ui&prompt=1&uio=OT10cnVlJjExPTEyMwb9).
  35. ### Browser Support
  36. * Last 2 Versions FF, Chrome, IE (aka 10+)
  37. * Safari 6
  38. * IE 9+ (Browser prefix only)
  39. * Android 4
  40. * Blackberry 10
  41. ### Reaching Out
  42. 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)
  43. ### Roadmap
  44. * [Features Missing for 1.0](https://github.com/Semantic-Org/Semantic-UI/issues?direction=desc&milestone=1&page=1&sort=updated&state=open)
  45. * [Planned Updates for 1.X](https://github.com/Semantic-Org/Semantic-UI/issues?direction=desc&milestone=2&page=1&sort=updated&state=open)
  46. * [Additional Components Scoped for 2.0](https://github.com/Semantic-Org/Semantic-UI/issues?direction=desc&labels=&milestone=3&page=1&sort=updated&state=open)