From fbfe258a0fb8bd74da74d050ba6490152db2d354 Mon Sep 17 00:00:00 2001 From: Jack Lukic Date: Fri, 14 Nov 2014 14:03:02 -0500 Subject: [PATCH] Update GETTING-STARTED.md --- GETTING-STARTED.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/GETTING-STARTED.md b/GETTING-STARTED.md index 795fb3e7e..cb594fe09 100644 --- a/GETTING-STARTED.md +++ b/GETTING-STARTED.md @@ -25,7 +25,7 @@ The first time you run gulp you will be greeted with an interactive installer The installer will let you select which components to include, and specify paths for your project. -| | Installation Type | +| Installation Type | Description | | ------------- | ------------- | | Automatic | Installation will use the default paths, outputing css files to `dist/` and packaging all components together | | Express | Will let you move your site folder and your dist folder and select from a list of components to include in your concatenated release. | @@ -76,14 +76,16 @@ Keep in mind semantic will automatically adjust URLs in CSS and add vendor-prefi #### Advanced Usage > In addition to the paths set in `semantic.json`, you can serve files to a second location, for example, a docs instance by using a separate config file `tasks/admin/docs.json`. Using a copy of the SUI documentation may work well internally for creating a style guide to hack on the theme designs for your project. + ```bash gulp serve-docs gulp build-docs ``` + ### Workflow Building and watching Semantic is only necessary while adjusting your UI. This is usually the first part of building a new project, and a separate process than building-out pages in your site. -During this architecting phase you can try downloading different themes, adjusting your site-wide settings (font-family, colors, etc) and tweaking components in your site's component overrides. +During this architecting phase you can try downloading different themes, adjusting your site-wide settings (font-family, colors, etc) and tweaking components in your site's component overrides. Files in the `examples/` folder of your project can be useful for testing out changes in your UI. For example, you might run `gulp watch` download a new theme to `src/site/themes/` then adjust your `theme.config` file with the name of the new theme and refresh `examples/kitchensink.html` to inspect changes in the theme. You will only need to use Semantic's build tools while refining your UI, while designing pages you can rely on the packages in `dist/` and your software stack's normal build set-up.