diff --git a/scripts/README.md b/scripts/README.md index a3a4f48b7b..0bed90fe1c 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -10,29 +10,41 @@ feel for what's available. cd scripts ``` -* Start the demo and Install all the dependencies (*Note. do it this way only the first time, and be aware, it will take some time*) +Start using published components +--- + +This is recommended if you are running from the `master` branch. + +Start the demo-shell app after installing all the dependencies from npm (*Note. do it this way only the first time, and be aware, it will take some time*) ```sh ./start.sh -install ``` -* Start the demo (*the standard way of starting the demo after first initialization*): +Or, if you have previously run `-install` but want to update the dependencies, use `-update` + +```sh +./start.sh -update +``` + +If there are no big changes in the demo-shell since you last started then you can start without `-install` and `-update` to skip fetching packages, which should be much quicker ```sh ./start.sh ``` -* Start the demo, install all the dependencies, and remove the previous version of the npm packages (*Note. do this only after big changes*): +If you get errors when starting which do not go away with `-update` or `-install,` or if you want to test starting the demo shell from a clean environment, then use the `-cleanInstall` option + +This will remove previous versions of all packages, before running `npm install` again ```sh ./start.sh -cleanInstall ``` -* Start the demo and update the dependencies: +Start using linked components +--- -```sh -./start.sh -update -``` +This is recommended if you are using the `development` branch or a feature branch off `development` * If you want to use your local components use the following script with any of the previous option. It will npm link all the components in the demo shell: @@ -41,4 +53,4 @@ in the demo shell: ./start-linked.sh ``` -For development environment configuration please refer to [project docs](demo-shell-ng2/README.md). \ No newline at end of file +For development environment configuration please refer to [project docs](demo-shell-ng2/README.md).