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.

91 lines
4.1 KiB

10 years ago
10 years ago
10 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.svg?branch=master)](https://travis-ci.org/Semantic-Org/Semantic-UI?branch=master)
  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. > 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).
  5. ### Project Status
  6. **Semantic is being reworked for a ``1.0`` release for Spring.**
  7. Although the pre-release branch ``0.x.x`` is actively being maintained, most important features like better theming support, and new components will land in ``1.0``.
  8. Beta documentation will be available soon for testers and early adopters.
  9. ## Translations
  10. ##### Right-to-Left (RTL Version)
  11. Special RTL versions are maintained with the Arabic translation of Semantic.
  12. * سيمانتك يو آي - الإصدار العربي - [GitHub](https://github.com/Semantic-Org/Semantic-UI-ar) - [Website](http://semantic-ui.me/)
  13. ##### Additional Translations
  14. * 中文翻译 Semantic UI - [GitHub](https://github.com/Semantic-Org/Semantic-UI-zh) - [Website](http://zh.semantic-ui.com/)
  15. * Tradução em Português - [GitHub](https://github.com/Semantic-Org/Semantic-UI-pt-br)
  16. We need people who can contribute to translations of Semantic UI's documentation.
  17. Please [reach out by e-mail](mailto:jack@semantic-ui.com) if you can help.
  18. ## Getting Started
  19. 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.
  20. To download the entire library
  21. git clone git@github.com:Semantic-Org/Semantic-UI.git
  22. If you prefer to download the whole kit as a zip, it is so conveniently packaged.
  23. http://semantic-ui.com/build/semantic.zip
  24. Semantic is also available from CDN
  25. * [Hosted on CloudFlare CDN](http://cdnjs.com/libraries/semantic-ui/)
  26. * [Hosted on BootCDN](http://open.bootcss.com/semantic-ui/) (Chinese)
  27. ## Learn More
  28. * [Introduction to Semantic](http://www.semantic-ui.com/introduction.html)
  29. * [Semantic Modules](http://www.semantic-ui.com/module.html)
  30. * [Contributing to Semantic](http://semantic-ui.com/project/contributing.html)
  31. * [Running Docs/Server Locally](http://semantic-ui.com/project/development)
  32. If you want to keep track of development, please [join our google group](https://groups.google.com/forum/?hl=en#!forum/semantic-ui)
  33. ### Bugs and Issues
  34. > Semantic UI is production ready, but is "pre-release" until build and theming tools are available, and documentation is complete for all components.
  35. 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.
  36. 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.
  37. 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).
  38. ### Browser Support
  39. * Last 2 Versions FF, Chrome, IE (aka 10+)
  40. * Safari 6
  41. * Firefox 12
  42. * IE 9+ (Browser prefix only)
  43. * Android 3
  44. * Blackberry 10
  45. ### Reaching Out
  46. 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)
  47. ### Roadmap
  48. * [Features Missing for 1.0](https://github.com/Semantic-Org/Semantic-UI/issues?direction=desc&milestone=1&page=1&sort=updated&state=open)
  49. * [Planned Updates for 1.X](https://github.com/Semantic-Org/Semantic-UI/issues?direction=desc&milestone=2&page=1&sort=updated&state=open)
  50. * [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)
  51. [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Semantic-Org/semantic-ui/trend.png)](https://bitdeli.com/free "Bitdeli Badge")