From b6c69163c140e2ad5fe470de1ce5603ae848bf53 Mon Sep 17 00:00:00 2001 From: jlukic Date: Tue, 28 Oct 2014 17:09:49 -0400 Subject: [PATCH] Add renamed files --- GETTING-STARTED.md | 63 ++++ RELEASE-NOTES.md | 772 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 835 insertions(+) create mode 100644 GETTING-STARTED.md create mode 100644 RELEASE-NOTES.md diff --git a/GETTING-STARTED.md b/GETTING-STARTED.md new file mode 100644 index 000000000..b1fab7ec1 --- /dev/null +++ b/GETTING-STARTED.md @@ -0,0 +1,63 @@ +## Quick and Dirty Set-up + +1) Rename the site configuration folder from ``/themes/_site`` to ``themes/site`` to avoid library updates modifying your site's settings. + +2) Rename your semantic config file from ``semantic.config.example`` to ``semantic.config`` + +3) Use ``grunt build`` to output your project files, you can configure the paths used in ``grunt.config``. + +## Overview +* ``definitions/`` - contain all UI definitions +* ``themes/packaged/default`` are the default UI styling of an element +* ``themes/packaged`` are downloaded from the web or a package manager and provide preset overrides +* ``themes/user`` are the only files you should modify, these are your site's overrides for LESS and variables + +## Building CSS + +To make development easier, Semantic has a built in grunt config for building your project. Simply modify the **grunt.config** with the directories you need. + +You can also build the source files with any processor for LESS. Just keep in mind to customize ``site.variables`` with your asset paths for images and fonts. + +For information on installing grunt [see their guide](http://gruntjs.com/installing-grunt) + +## Customizing Semantic + +**There is only one folder you should ever edit files in ``themes/site``.** These are your site's LESS overrides and variable settings. + +### Using a default theme +Leaving an element as ``default`` will use baseline UI stylings. + +The inheritance order when using default is: +1) ``themes/default/elements/button.variables`` loads the baseline UI variables +2) ``themes/packaged/default/elements/button.variables`` loads a blank file +3) ``themes/sites/elements.button.variables`` loads your variable overrides + +### Using a packaged theme +Packaged themes can be downloaded from the internet, and placed inside ``themes/packaged/`` + +To use a packaged theme change the value inside ``semantic.config`` to the theme name. + +For example if you change your button theme to 'chubby' the following load order would occur: + +1) ``themes/default/elements/button.variables`` loads the UI variables +2) ``themes/packaged/chubby/elements/button.variables`` loads the "downloadable" theme (this will allow for community packages) In this example, a button theme called *chubby* +3) ``themes/sites/elements.button.variables`` loads **your overrides for variables** + +## Adjust your site's configuration + +To customize a ``ui button`` you can +* Add variable overrides in ``site/elements/button.variables`` +* Add user LESS/CSS overrides in ``/site/elements/button.overrides`` (this will have all variables accessible) + +Semantic now also includes some site-wide configuration by default in ``site.less`` it is recommended you include this also. + +## Advanced grunt usage + +``grunt reset`` - Clears your build directory. Use this if you have a source file that is no longer being tracked. + +``grunt build`` - This will build all files (not just watched files) in your source directory + +## Gotchas & Tips + +Semantic **now requires a box-sizing reset** this allows us more flexibility inside the framework to not deal with issues related to calculating padding. This is included in ``site.less`` as well as a standard HTML reset. + diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md new file mode 100644 index 000000000..09c9cd92b --- /dev/null +++ b/RELEASE-NOTES.md @@ -0,0 +1,772 @@ +## RELEASE NOTES + +### Version 1.0.0 - XX XX, 2014 + +**Breaking Changes** +- **Word Order** - Many multi word variations now require proper word order, for example ``left aligned`` or ``right floated`` classnames must be adjacent. This is to prevent conflicts with other multiple word variations +- **Form** - Date field has been removed, use a ``ui icon input`` with a ``calendar icon`` instead +- **Label** - Corner labels no longer support text, only icons. +- **Form** - Standard grids now have gutters on left and right of first and last column. ``ui fitted grid`` can be used to remove these margins +- **Dropdown** - Sub menus inside dropdowns now need a wrapping div **text** around sub-menu descriptions +- **Header** - Headers now do not automatically resize based on h1-h6 +- **Checkbox** - Checkbox "enable" and "disable" have been replaced with "check" and "uncheck" +- **Modal** - Modal ``left`` and ``right`` sections are now replaced with ``image`` and ``description`` +- **Accordion** - Accordions are not unstyled by default allowing for more compatability with other modules without having to override styles. Styled accordions are now included as a variation ``ui styled accordion`` +- **List** - List item selectors are now more strict, list items must be immediate children of ``ui list`` or ``ui list list`` +- **Item** - Items have now been renamed "card" to allow for a more generic item list that does not use a "card" style. Some 'card' view content has been slightly adjusted. Please refer to documentation +- **Header / Icon** - Inverted headers and icons no longer invert background colors, but instead use a lighter version of colors more legible on dark backgrounds. Inverted circular icons, still however invert the color of the circle. +- **Input** - Labeled inputs now have ``corner`` ``left`` and ``top`` labels. Any labeled inputs must now be converted to ``corner labeled input`` to maintain default position in ``0.x`` +- **Modal** - AllowMultiple (allowing multiple modals at once) is now set to **false** by default. +- **Table** - Tables are no longer striped by default, instead you must specify the 'striped' variation + +**Enhancements** +- **General** - CSS animations now hint with will change properties to increase performance in supported browsers +- **General** - Many modules now use DOM Mutations and event delegation to allow content adjustment after initialization +- **Accordion** - Accordion now includes all icons in an embedded font instead of requiring icons +- **Button** - Now has compact form, used for fitting into tight spaces +- **Button** - Now has CSS loaders to allow loading state to maintain other styles +- **Checkbox** - Now correctly handles read-only and disabled, has read-only and disabled states +- **Checkbox** - All styles have been redone. Standard checkboxes are now based around PX and not EM making sure there are no unusual circles or rounding issues. Checkboxes also now use a custom font for glyphs instead of CSS tricks. +- **Checkbox** - Checkbox now have a ``fireOnInit`` setting for firing callbacks on page load +- **Checkbox** - Checkbox now receive a ``checked`` class when checked, making it easier to write css selectors on checked checkboxes, for example when using sibling selectors ``.ui.checked.checkbox + .content { // style }`` +- **Dropdown** - New dropdown type, searchable selection for large lists of choices +- **Dropdown** - Dropdowns can now be initialized directly on a ``