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.

68 lines
3.6 KiB

10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
11 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
11 years ago
10 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) 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?** Ask for help on in our [IRC chat](http://webchat.freenode.net/?randomnick=1&channels=%23semantic-ui&prompt=1&uio=OT10cnVlJjExPTEyMwb9), ask about Semantic UI on [StackOverflow](http://www.stackoverflow.com) or ask a question to 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.
  18. * **Want to help others learn concepts behind Semantic?** [LearnSemantic](http://www.learnsemantic.com) needs writers who can get others up to speed with Semantic UI, the definition format. In particular, a "Beginner's Guide" for those who are new to development. [Send me an e-mail](mailto:jack@semantic-ui.com) if you are interested
  19. ## Getting Started
  20. Semantic is best used actively during development. We have included build tools for maintaining changes to Semantic as you work.
  21. ![Getting Started](https://dl.dropboxusercontent.com/u/2657007/install.gif)
  22. ```
  23. npm install
  24. gulp
  25. ```
  26. Running gulp for the first time will start the interactive set-up.
  27. 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.
  28. 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.
  29. Once set-up you can use these commands to maintain your project
  30. ```nodejs
  31. gulp // defaults to watch after install
  32. gulp build // build all files from source
  33. gulp clean // clears your dist folder
  34. gulp watch // watch files
  35. gulp install // re-runs install
  36. gulp help // list all commands
  37. ```
  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)
  46. [![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)