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.

96 lines
4.5 KiB

9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
11 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 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
9 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-NOTES.md#version-100---november-24-2014) for changes from the pre-release.
  10. ## Community Support
  11. * **Want to learn about Semantic?** [Request an Invite](https://docs.google.com/forms/d/1hI1z136sXLkTQKtsv8SIvjjAvzpH77YzMQKrU-P8GAc/viewform?usp=send_form) to join [our Slack chatroom](http://semanticui.slack.com) for support and project discussions
  12. * **Have a bug?** Make a test case by forking this [jsfiddle](http://jsfiddle.net/efp8z6Ln/), then submit a [bug on GitHub](https://github.com/Semantic-Org/Semantic-UI/issues)
  13. * **Having issues with your code?** Join our [IRC chat](http://webchat.freenode.net/?randomnick=1&channels=%23semantic-ui&prompt=1&uio=OT10cnVlJjExPTEyMwb9), submit a question on [StackOverflow](http://www.stackoverflow.com) or ask our [Google Group](https://groups.google.com/forum/#!forum/semantic-ui)
  14. * **Looking for a specific integration like Dart, Wordpress, Angular, or Rails?** Check out our [integration page](https://github.com/Semantic-Org/Semantic-UI/wiki/Integration)
  15. ## Contributing
  16. * **Missing documentation in your language?** Help us make Semantic available in more languages by [joining our translation community](https://www.transifex.com/organization/semantic-org/)
  17. * **Want to help with integration?** Projects are organizing for official [Meteor](https://github.com/Semantic-Org/Semantic-UI-Meteor), and [Angular](https://github.com/Semantic-Org/Semantic-UI-Angular) integrations as well as a [SASS](https://github.com/Semantic-Org/Semantic-UI-SASS) port. Join the discussion on their respective boards.
  18. * **Want to help others learn concepts behind Semantic?** [Learnsemantic.com](http://www.learnsemantic.com) needs articles to help others get others up to speed with Semantic UI. [Send me an e-mail](mailto:jack@semantic-ui.com) if you are interested.
  19. ## Getting Started
  20. ### Basic Usage (Default Theme)
  21. We recommend setting up the Semantic build workflow to support on-the-fly
  22. theming and customization, but it is not required.
  23. To use the "ready-to-use" distribution version, which includes all components, simply link to
  24. `dist/semantic.js` and `dist/semantic.css` (or their minified counterparts) in your page.
  25. ``` html
  26. <link rel="stylesheet" type="text/css" href="/dist/semantic.min.css">
  27. <script src="/dist/semantic.min.js"></script>
  28. ```
  29. You may also prefer to use individual components found in `dist/components` to reduce the libraries file size.
  30. ``` html
  31. <link rel="stylesheet" type="text/css" href="/dist/components/icon.css">
  32. ```
  33. ### Recommended Usage (Themed)
  34. Semantic is best used actively during development. We have included build tools for updating your site's theme as you work.
  35. ![Getting Started](https://dl.dropboxusercontent.com/u/2657007/install.gif)
  36. ```
  37. npm install
  38. gulp
  39. ```
  40. Running gulp for the first time will start the interactive set-up.
  41. 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.
  42. 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.
  43. Once set-up you can use these commands to maintain your project
  44. ```nodejs
  45. gulp // defaults to watch after install
  46. gulp build // build all files from source
  47. gulp clean // clears your dist folder
  48. gulp watch // watch files
  49. gulp install // re-runs install
  50. gulp help // list all commands
  51. ```
  52. For more detail into how work with Semantic when building a site please [read out customization guide](http://learnsemantic.com/developing/customizing.html) on [LearnSemantic.com](http://learnsemantic.com/)
  53. ## Browser Support
  54. * Last 2 Versions FF, Chrome, IE (aka 10+)
  55. * Safari 6
  56. * IE 9+ (Browser prefix only)
  57. * Android 4
  58. * Blackberry 10
  59. ## Reaching Out
  60. 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)
  61. [![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)