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.

64 lines
2.6 KiB

11 years ago
11 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
  1. # Semantic
  2. Semantic uses principles of natural language to create a re-usable language for UI.
  3. 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**.
  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. > 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).
  6. ## Translations
  7. Translations are available directly [in the docs](http://www.semantic-ui.com), using the language toolbar.
  8. ## Getting Started
  9. Semantic is best used actively during development. We have included build tools for maintaining changes to Semantic as you work.
  10. ![Getting Started](https://dl.dropboxusercontent.com/u/2657007/install.gif)
  11. ```
  12. npm install
  13. gulp
  14. ```
  15. Running gulp for the first time will start the interactive set-up.
  16. 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.
  17. 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.
  18. Once set-up you can use these commands to maintain your project
  19. ```nodejs
  20. gulp // defaults to watch after install
  21. gulp build // build all files from source
  22. gulp clean // clears your dist folder
  23. gulp watch // watch files
  24. gulp install // re-runs install
  25. gulp help // list all commands
  26. ```
  27. ### Bugs and Issues
  28. > Semantic UI is production ready, but is "pre-release" until build and theming tools are available, and documentation is complete for all components.
  29. 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.
  30. If you are reporting a bug *you must create a test-case*. You can [fork this jsfiddle](http://jsfiddle.net/J9MkJ/32/) to get you started.
  31. 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).
  32. ### Browser Support
  33. * Last 2 Versions FF, Chrome, IE (aka 10+)
  34. * Safari 6
  35. * IE 9+ (Browser prefix only)
  36. * Android 4
  37. * Blackberry 10
  38. ### Reaching Out
  39. 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)