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.

73 lines
3.6 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. ### Translations
  6. * [中国翻译 Semantic UI](http://semantic.icoolxue.com/)
  7. We need people who can contribute to translations of Semantic UI's documentation.
  8. Please [reach out by e-mail](mailto:jack@semantic-ui.com) if you can help.
  9. ### Bugs and Issues
  10. > Semantic UI is production ready, but is "pre-release" until build and theming tools are available, and documentation is complete for all components.
  11. 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.
  12. 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.
  13. ### Browser Support
  14. * Last 2 Versions FF, Chrome, IE (aka 10+)
  15. * Safari 6
  16. * IE 9+ (Browser prefix only)
  17. * Android 4
  18. * Blackberry 10
  19. ## Getting Started
  20. 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.
  21. To download the entire library
  22. git clone git@github.com:Semantic-Org/semantic.git
  23. If you prefer to download the whole kit as a zip, it is so conveniently packaged.
  24. http://semantic-ui.com/build/semantic.zip
  25. **Build tools for creating customized downloads will be available in 1.0** Until then we suggest using an asset management tool like [grunt](https://github.com/gruntjs/grunt-cli) or [jammit](https://github.com/documentcloud/jammit) to create packaged versions for use in production.
  26. 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).
  27. #### Right-to-Left (RTL Version)
  28. RTL versions are compiled on every patch update, and are available in ``/rtl/``
  29. ### Integration
  30. Comunity contributed plugins and ports for Wordpress, Angular, Knockout, Rails, and more can be found on the [Integration page](https://github.com/Semantic-Org/Semantic-UI/wiki/Integration).
  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. #### Reaching Out
  38. 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)
  39. ### Roadmap
  40. * [Features Missing for 1.0](https://github.com/Semantic-Org/Semantic-UI/issues?direction=desc&milestone=1&page=1&sort=updated&state=open)
  41. * [Planned Updates for 1.X](https://github.com/Semantic-Org/Semantic-UI/issues?direction=desc&milestone=2&page=1&sort=updated&state=open)
  42. * [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)