From 30a5acfd8b4126e6b4efe70f1e01bfebac17f766 Mon Sep 17 00:00:00 2001 From: Jack Lukic Date: Thu, 19 Feb 2015 12:08:00 -0500 Subject: [PATCH 1/3] Update README.md --- src/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/src/README.md b/src/README.md index 04e2d8d38..814a4f1a5 100644 --- a/src/README.md +++ b/src/README.md @@ -37,9 +37,7 @@ gulp.task('watch ui', 'Watch Semantic UI', watch)); > LESS files do not contain vendor prefixes. If you are to use these files directly you must add them during your build step. -Before using source files you will need to create a `theme.config` by renaming `theme.config.example` - -This file is used to configure which packaged theme each component should use. +Before using source files you will need to create a `theme.config` by renaming `theme.config.example`, and a site folder by renaming `_site/` to `site/` You can then import Semantic from your own LESS files: ```less @@ -53,6 +51,17 @@ To import individual components you will have to create a scope for each import & { @import 'src/definitions/elements/button'; } ``` +### Config Files + +These files are generated automatically using install scripts, but must be manually renamed if you are using installing manually. + +filename | usage | Initial Name +--- | --- | --- +`theme.config` | config file that stores each element's current theme for LESS | `theme.config.example` +`site/` | folder storing all your site's variables and css overrides for each UI component | `_site/` +`semantic.json` | stores folder paths for build tools and current installed version for updates. Only necessary when using build tools | `semantic.json.example` + + ## Theming ### Concepts From 86b21ab4f785b62797c6c658f133ff0d1a16b0c1 Mon Sep 17 00:00:00 2001 From: Jack Lukic Date: Thu, 19 Feb 2015 12:08:32 -0500 Subject: [PATCH 2/3] Update README.md --- src/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/README.md b/src/README.md index 814a4f1a5..d7df9c016 100644 --- a/src/README.md +++ b/src/README.md @@ -57,9 +57,9 @@ These files are generated automatically using install scripts, but must be manua filename | usage | Initial Name --- | --- | --- -`theme.config` | config file that stores each element's current theme for LESS | `theme.config.example` -`site/` | folder storing all your site's variables and css overrides for each UI component | `_site/` -`semantic.json` | stores folder paths for build tools and current installed version for updates. Only necessary when using build tools | `semantic.json.example` +theme.config | config file that stores each element's current theme for LESS | theme.config.example +site/ | folder storing all your site's variables and css overrides for each UI component | _site/ +semantic.json | stores folder paths for build tools and current installed version for updates. Only necessary when using build tools | semantic.json.example ## Theming From 9c70012fa1a6ad13c58c37f990bf57e3a1844830 Mon Sep 17 00:00:00 2001 From: Jack Lukic Date: Thu, 19 Feb 2015 12:09:06 -0500 Subject: [PATCH 3/3] Update README.md --- src/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/README.md b/src/README.md index d7df9c016..0ed864e3d 100644 --- a/src/README.md +++ b/src/README.md @@ -57,9 +57,9 @@ These files are generated automatically using install scripts, but must be manua filename | usage | Initial Name --- | --- | --- -theme.config | config file that stores each element's current theme for LESS | theme.config.example -site/ | folder storing all your site's variables and css overrides for each UI component | _site/ -semantic.json | stores folder paths for build tools and current installed version for updates. Only necessary when using build tools | semantic.json.example +**theme.config** | config file that stores each element's current theme for LESS | theme.config.example +**site/** | folder storing all your site's variables and css overrides for each UI component | _site/ +**semantic.json** | stores folder paths for build tools and current installed version for updates. Only necessary when using build tools | semantic.json.example ## Theming