inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve README contents

Browse Source
This commit is contained in:
Will Abson
2016-07-28 11:45:08 +01:00
parent 6ff5a4326d
commit 74933e8069
1 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
scripts/README.md
View File

@@ -10,29 +10,41 @@ feel for what's available.
cd scripts 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 ```sh
./start.sh -install ./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 ```sh
./start.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 ```sh
./start.sh -cleanInstall ./start.sh -cleanInstall
``` ```
* Start the demo and update the dependencies: Start using linked components
---
```sh This is recommended if you are using the `development` branch or a feature branch off `development`
./start.sh -update
```
* 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 * 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: in the demo shell: