diff --git a/README.md b/README.md index 006a35719b..41188bdb44 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,57 @@ # ALFRESCO WEB COMPONENTS -### Running demo project +### Configuring development environment + +Get a copy ```sh git clone https://github.com/Alfresco/dev-platform-webcomponents.git +``` + +Install symlinks for Alfresco components + +*ng2-alfresco-documentlist component:* + +```sh +cd ng2-components/ng2-alfresco-documentlist +npm link +cd ../../demo-shell-ng +npm link ng2-alfresco-documentlist +``` + +*ng2-alfresco-login component:* + +```sh +cd ng2-components/ng2-alfresco-login +npm link +cd ../../demo-shell-ng +npm link ng2-alfresco-login +``` + +### Building and running + +**Install dependencies:** + + +```sh cd dev-platform-webcomponents/demo-shell-ng2/ npm install +``` + +**Build and watch with Gulp:** + +```sh npm run build.dev ``` + +*or* + +```sh +gulp dev +``` + +**Fast build and watch for dev purposes:** + +```sh +npm start +```