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.

95 lines
4.7 KiB

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