From 95e634e046d4d4e0d4ad105b1d07fe13c754134e Mon Sep 17 00:00:00 2001 From: jlukic Date: Mon, 20 Oct 2014 16:10:03 -0400 Subject: [PATCH] Updating readme --- README.md | 28 +++++++++++++++++++++++++++- tasks/questions.js | 2 +- 2 files changed, 28 insertions(+), 2 deletions(-) mode change 100644 => 100755 README.md diff --git a/README.md b/README.md old mode 100644 new mode 100755 index dda930b71..77cf99e3c --- a/README.md +++ b/README.md @@ -13,7 +13,33 @@ Translations are available directly [in the docs](http://www.semantic-ui.com), u ## Getting Started -This is being solidified. Check back. +Semantic uses ``Gulp`` to automate build tasks. The first time you get Semantic, run ``npm install`` to grab our gulp dependencies so that you can build the project. + +``` +npm install +``` + +Running gulp for the first time will start the interactive set-up. + +This helps you create two important files ``semantic.json`` which is used by gulp to build your project, and ``themes.config`` a central file for choosing each components theme. + +You can also set-up which components you want to include in your packaged release, ignoring parts of Semantic you may not use. + +```nodejs +gulp +``` + +You can use additional commands once you finish set-up to your project +```nodejs +gulp // defaults to watch after install +gulp build // build all files from source +gulp clean // clears your dist folder +gulp watch // watch files +gulp install // re-runs install +gulp help // list all commands +``` + + ### Bugs and Issues diff --git a/tasks/questions.js b/tasks/questions.js index b8e8b0d8e..a947de05a 100755 --- a/tasks/questions.js +++ b/tasks/questions.js @@ -86,7 +86,7 @@ module.exports = { { type: 'checkbox', name: 'components', - message: 'What components should we include in the package? (Toggle with spacebar)', + message: 'What components should we include in the package?', choices: [ { name: "button", checked: true }, { name: "divider", checked: true },