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
2.8 KiB

9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
11 years ago
11 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
9 years ago
11 years ago
  1. ![Semantic](http://www.semantic-ui.com/images/logo.png)
  2. # Semantic UI
  3. Semantic is a highly-themable UI framework with naming conventions built around common usage.
  4. Key Features
  5. * 50+ UI Elements
  6. * 3000 + CSS Variables
  7. * 3 Levels of Variable Inheritance (Similar to SublimeText)
  8. * Built using EM values for responsive design
  9. Semantic UI is now at 1.0, be sure to check out our [release notes](https://github.com/Semantic-Org/Semantic-UI/blob/master/RELEASE%20NOTES.md) for changes from the pre-release.
  10. [![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)
  11. > 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).
  12. ## Translations
  13. Translations are available directly [in the docs](http://www.semantic-ui.com), using the language toolbar.
  14. ## Getting Started
  15. Semantic is best used actively during development. We have included build tools for maintaining changes to Semantic as you work.
  16. ![Getting Started](https://dl.dropboxusercontent.com/u/2657007/install.gif)
  17. ```
  18. npm install
  19. gulp
  20. ```
  21. Running gulp for the first time will start the interactive set-up.
  22. This helps you create two important files ``semantic.json`` which stores your folder set-up, and ``themes.config`` a central file for setting ui themes.
  23. The install utility will also help you set-up which components you want to include in your packaged release, ignoring parts of Semantic you may not use.
  24. Once set-up you can use these commands to maintain your project
  25. ```nodejs
  26. gulp // defaults to watch after install
  27. gulp build // build all files from source
  28. gulp clean // clears your dist folder
  29. gulp watch // watch files
  30. gulp install // re-runs install
  31. gulp help // list all commands
  32. ```
  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/71dt95dr/) 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. * IE 9+ (Browser prefix only)
  42. * Android 4
  43. * Blackberry 10
  44. ### Reaching Out
  45. 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)