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.

58 lines
3.2 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/jlukic/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/jlukic/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. ### Bugs and Issues
  6. > Semantic UI is production ready, but is "pre-release" until build and theming tools are available, and documentation is complete for all components.
  7. Please [share any issues](https://github.com/jlukic/Semantic-UI/issues?state=open) you may have, we need your help to get all the kinks out.
  8. 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.
  9. ## Getting Started
  10. 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.
  11. To download the entire library
  12. git clone git@github.com:quirkyinc/semantic.git
  13. If you prefer to download the whole kit as a zip, it is so conveniently packaged.
  14. http://semantic-ui.com/build/semantic.zip
  15. **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.
  16. 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).
  17. #### Right-to-Left (RTL Version)
  18. RTL versions are compiled on every patch update, and are available in ``/rtl/``
  19. ### Integration
  20. Comunity contributed plugins and ports for Wordpress, Angular, Knockout, Rails, and more can be found on the [Integration page](https://github.com/jlukic/Semantic-UI/wiki/Integration).
  21. ## Learn More
  22. * [Introduction to Semantic](http://www.semantic-ui.com/introduction.html)
  23. * [Semantic Modules](http://www.semantic-ui.com/module.html)
  24. * [Contributing to Semantic](http://semantic-ui.com/project/contributing.html)
  25. * [Running Docs/Server Locally](http://semantic-ui.com/project/development)
  26. If you want to keep track of development, please [join our google group](https://groups.google.com/forum/?hl=en#!forum/semantic-ui)
  27. #### Reaching Out
  28. 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)
  29. ### Roadmap
  30. * [Features Missing for 1.0](https://github.com/jlukic/Semantic-UI/issues?direction=desc&milestone=1&page=1&sort=updated&state=open)
  31. * [Planned Updates for 1.X](https://github.com/jlukic/Semantic-UI/issues?direction=desc&milestone=2&page=1&sort=updated&state=open)
  32. * [Additional Components Scoped for 2.0](https://github.com/jlukic/Semantic-UI/issues?direction=desc&labels=&milestone=3&page=1&sort=updated&state=open)