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.

65 lines
3.1 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
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
  1. # Semantic
  2. [![Build Status](https://travis-ci.org/jlukic/Semantic-UI.png)](https://travis-ci.org/jlukic/Semantic-UI)
  3. Semantic is a set of specifications for sharing UI elements between developers. Semantic is also a UI library to make front end development simpler and easier to learn.
  4. Semantic is production ready, but is formally "pre-release" until proper build and theming tools are available, and documentation is complete for all components.
  5. [![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)
  6. ## Getting Started
  7. 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.
  8. To download the entire library
  9. git clone git@github.com:quirkyinc/semantic.git
  10. If you prefer to download the whole kit as a zip, it is so conveniently packaged.
  11. http://semantic-ui.com/build/semantic.zip
  12. **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.
  13. #### Right-to-Left (RTL Version)
  14. RTL versions are compiled on every patch update, and are available in ``/rtl/``
  15. #### LESS Semantic UI
  16. More css-processing features are currently being added to help in the customizing and theming Semantic UI. This will be one of the core features additions for Semantic's first release version.
  17. #### SASS/SCSS Semantic UI
  18. If you are looking for a SCSS/SASS port of Semantic for your rails projects check out doabit's [Semantic UI for SASS](https://github.com/doabit/semantic-ui-sass)
  19. ## About the Project
  20. ### Learn More
  21. * [Introduction to Semantic](http://www.semantic-ui.com/introduction.html)
  22. * [Contributing to Semantic](http://semantic-ui.com/project/contributing.html)
  23. * [Running Docs/Server Locally](http://semantic-ui.com/project/development)
  24. If you want to keep track of development, please [join our google group](https://groups.google.com/forum/?hl=en#!forum/semantic-ui)
  25. #### I want to contribute to Semantic
  26. Semantic is very new standard, and we need a community to become truly useful.
  27. If you'd like to start a conversation about Semantic feel free to reach out by e-mail [jack@myfav.es](mailto:jack@myfav.es)
  28. ### Bugs and Issues
  29. 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.
  30. If you are reporting a bug *you must create a test-case*. You can [fork this jsfiddle](http://jsfiddle.net/jlukic/Vbr9d/1/) to get you started.
  31. ### Roadmap
  32. * [Features Missing for 1.0](https://github.com/jlukic/Semantic-UI/issues?direction=desc&milestone=1&page=1&sort=updated&state=open)
  33. * [Planned Updates for 1.X](https://github.com/jlukic/Semantic-UI/issues?direction=desc&milestone=2&page=1&sort=updated&state=open)
  34. * [Additional Components Scoped for 2.0](https://github.com/jlukic/Semantic-UI/issues?direction=desc&labels=&milestone=3&page=1&sort=updated&state=open)