readme files

README.md

@@ -6,7 +6,7 @@
 
 # Examples of Ignite UI for Angular Components
 
-This repository contains over 400 examples on how to use [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-Angular/Angular/components/general-getting-started.html) components:
+This repository contains an Angular browser app and 500+ examples on how to use [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-Angular/Angular/components/general-getting-started.html) components:
 
 - Charts:
 [Area](https://www.infragistics.com/products/ignite-ui-angular/angular/components/charts/types/area-chart),
@@ -32,6 +32,12 @@ This repository contains over 400 examples on how to use [Ignite UI for Angular]
 [Linear Gauge](https://www.infragistics.com/products/ignite-ui-angular/angular/components/linear-gauge.html),
 [Radial Gauges](https://www.infragistics.com/products/ignite-ui-angular/angular/components/radial-gauge.html)
 
+You can run each sample project individually from the ./samples folder or you can browse all samples in one website from the ./browser folder.
+
+## Branches
+
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
+
 ## Preview
 
 You can preview and browse all samples in this repository by opening our [Angular Samples Browser](https://www.infragistics.com/angular-demos-dv/samples/). Alternatively, you you can view these samples with detailed information in our [Angular Help Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/general-getting-started).
@@ -49,13 +55,17 @@ To set up this project locally, clone this repository:
 git clone https://github.com/IgniteUI/igniteui-angular-examples.git
 ```
 
+
 ## Running Individual Sample
 
+- check out the **master** branch
+
 - in VS Code, open a folder with existing sample, e.g.
 ```
 ./samples/charts/category-chart/axis-options/
 ```
-- type `npm install` command in terminal window
+- type `npm install --legacy-peer-deps` command in terminal window
+
 - type `npm run start` command in terminal window
 
 - Wait until the build is completed and then open [http://localhost:4200](http://localhost:4200) in your browser.
@@ -65,11 +75,18 @@ At this point, you should see a website hosted example of [Ignite UI for Angular
 
 ## Running All Samples
 
+- check out the **master** branch
+
 - open VS Code as Administrator
-- open the folder that contains this repository, e.g. `C:\GitHub\igniteui-angular-examples\`
+
+- open the folder that contains this repository, e.g.
+```CMD
+C:\GitHub\igniteui-angular-examples\
+```
+
 - select **View** - **Terminal** menu item
 
-- type `npm install` command in terminal window
+- type `npm install --legacy-peer-deps` command in terminal window
 
 This will install required packages and [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-angular/angular/components/general-getting-started) packages
 
@@ -108,7 +125,7 @@ Wait until the build is completed and then open [http://localhost:4200](http://l
 
 - rename class to the name of .tsx file
 
-- type `npm install` command in terminal window
+- type `npm install --legacy-peer-deps` command in terminal window
 
 - type `npm run start` command in terminal window
 

browser/README.md

@@ -9,22 +9,31 @@
 
 # Browser App for Angular Components
 
-This browser application allows you to browse all samples of the [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-Angular/Angular/components/general-getting-started.html) in a single website.
+The **browser** folder contains an Angular app for browsing 500+ examples of [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-Angular/Angular/components/general-getting-started.html) components.
 
-## Setup
-To setup the project run:
 
-```
-npm install
-```
+## Branches
 
-To start the dev server (including IE support) run:
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
 
-```
-npm run start
-```
 
-## Running with the DocFX project
+## Instructions
+
+Follow these instructions to run and browse all samples:
+
+- open VS Code as Administrator
+
+- open the folder that contains this repository, e.g. `C:\GitHub\igniteui-angular-examples\`
+
+- select **View** - **Terminal** menu item
+
+- type `npm install --legacy-peer-deps` command in terminal window
+
+This will install required packages and [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-angular/angular/components/general-getting-started) packages
+
+- type `npm run start` command in terminal window to start this application locally
+
+Note this application copies all individually sample projects from [./samples](./samples) to [./browser/src](./browser/src) folder when it is about to start running. Therefore, any changes to [./browser/src](./browser/src) will be overridden on consecutive run of the application.
+
+Wait until the build is completed and then open [http://localhost:4200](http://localhost:4200) in your browser. You should see a website with navigation menu for browning all samples in this repository.
 
-In order to combine the execution of both [DocFX](https://github.com/IgniteUI/igniteui-docfx) and Ignite UI Angular Samples projects, use `npm run start`.
-After starting both projects you will see the embed samples into the DocFX site builder, under `localhost:port` hostname.

samples/README.md

@@ -6,7 +6,7 @@
 
 # Individual Samples of Angular Components
 
-In this folder, you will find individual **samples** on how to use [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-Angular/Angular/components/general-getting-started.html) components:
+The **samples** folder contains individual examples on how to use [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-Angular/Angular/components/general-getting-started.html) components:
 
 - Charts:
 [Area](https://www.infragistics.com/products/ignite-ui-angular/angular/components/charts/types/area-chart),
@@ -33,14 +33,20 @@ In this folder, you will find individual **samples** on how to use [Ignite UI fo
 [Radial Gauges](https://www.infragistics.com/products/ignite-ui-angular/angular/components/radial-gauge.html)
 
 
-## Setup
+## Branches
+
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
+
+## Instructions
+
+Follow these instructions to run individual sample:
 
 - in VS Code, open a folder with existing sample, e.g.
 ```
 ./samples/charts/category-chart/axis-options/
 ```
 
-- type `npm install` command in terminal window
+- type `npm install --legacy-peer-deps` command in terminal window
 
 - type `npm run start` command in terminal window
 

samples/charts/category-chart/annotations-all/ReadMe.md

@@ -21,28 +21,36 @@ This folder contains Angular application with example of Annotations All feature
     </body>
 </html>
 
+## Branches
+
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
+
 ## Instructions
 
-To set up this project locally, execute these commands:
+Follow these instructions to run this example:
+
+
+- clone and navigate to this sample in terminal window
 
 ```
 git clone https://github.com/IgniteUI/igniteui-angular-examples.git
-cd ./igniteui-angular-examples
+git checkout master
 cd ../samples/charts/category-chart/annotations-all
 ```
+<!-- cd ./igniteui-angular-examples -->
 
-open above folder in VS Code or type:
+- open above folder in VS Code or type:
 ```
 code .
 ```
 
-In terminal window, run:
+- In terminal window, run:
 ```
 npm install --legacy-peer-deps
 npm run-script start
 ```
 
-Then open http://localhost:4200/ in your browser
+- open http://localhost:4200/ in your browser
 
 
 ## Learn More

samples/charts/category-chart/annotations-callouts/ReadMe.md

@@ -21,28 +21,36 @@ This folder contains Angular application with example of Annotations Callouts fe
     </body>
 </html>
 
+## Branches
+
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
+
 ## Instructions
 
-To set up this project locally, execute these commands:
+Follow these instructions to run this example:
+
+
+- clone and navigate to this sample in terminal window
 
 ```
 git clone https://github.com/IgniteUI/igniteui-angular-examples.git
-cd ./igniteui-angular-examples
+git checkout master
 cd ../samples/charts/category-chart/annotations-callouts
 ```
+<!-- cd ./igniteui-angular-examples -->
 
-open above folder in VS Code or type:
+- open above folder in VS Code or type:
 ```
 code .
 ```
 
-In terminal window, run:
+- In terminal window, run:
 ```
 npm install --legacy-peer-deps
 npm run-script start
 ```
 
-Then open http://localhost:4200/ in your browser
+- open http://localhost:4200/ in your browser
 
 
 ## Learn More

samples/charts/category-chart/annotations-crosshairs/ReadMe.md

@@ -21,28 +21,36 @@ This folder contains Angular application with example of Annotations Crosshairs
     </body>
 </html>
 
+## Branches
+
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
+
 ## Instructions
 
-To set up this project locally, execute these commands:
+Follow these instructions to run this example:
+
+
+- clone and navigate to this sample in terminal window
 
 ```
 git clone https://github.com/IgniteUI/igniteui-angular-examples.git
-cd ./igniteui-angular-examples
+git checkout master
 cd ../samples/charts/category-chart/annotations-crosshairs
 ```
+<!-- cd ./igniteui-angular-examples -->
 
-open above folder in VS Code or type:
+- open above folder in VS Code or type:
 ```
 code .
 ```
 
-In terminal window, run:
+- In terminal window, run:
 ```
 npm install --legacy-peer-deps
 npm run-script start
 ```
 
-Then open http://localhost:4200/ in your browser
+- open http://localhost:4200/ in your browser
 
 
 ## Learn More

samples/charts/category-chart/annotations-custom/ReadMe.md

@@ -21,28 +21,36 @@ This folder contains Angular application with example of Annotations Custom feat
     </body>
 </html>
 
+## Branches
+
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
+
 ## Instructions
 
-To set up this project locally, execute these commands:
+Follow these instructions to run this example:
+
+
+- clone and navigate to this sample in terminal window
 
 ```
 git clone https://github.com/IgniteUI/igniteui-angular-examples.git
-cd ./igniteui-angular-examples
+git checkout master
 cd ../samples/charts/category-chart/annotations-custom
 ```
+<!-- cd ./igniteui-angular-examples -->
 
-open above folder in VS Code or type:
+- open above folder in VS Code or type:
 ```
 code .
 ```
 
-In terminal window, run:
+- In terminal window, run:
 ```
 npm install --legacy-peer-deps
 npm run-script start
 ```
 
-Then open http://localhost:4200/ in your browser
+- open http://localhost:4200/ in your browser
 
 
 ## Learn More

samples/charts/category-chart/annotations-final-value/ReadMe.md

@@ -21,28 +21,36 @@ This folder contains Angular application with example of Annotations Final Value
     </body>
 </html>
 
+## Branches
+
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
+
 ## Instructions
 
-To set up this project locally, execute these commands:
+Follow these instructions to run this example:
+
+
+- clone and navigate to this sample in terminal window
 
 ```
 git clone https://github.com/IgniteUI/igniteui-angular-examples.git
-cd ./igniteui-angular-examples
+git checkout master
 cd ../samples/charts/category-chart/annotations-final-value
 ```
+<!-- cd ./igniteui-angular-examples -->
 
-open above folder in VS Code or type:
+- open above folder in VS Code or type:
 ```
 code .
 ```
 
-In terminal window, run:
+- In terminal window, run:
 ```
 npm install --legacy-peer-deps
 npm run-script start
 ```
 
-Then open http://localhost:4200/ in your browser
+- open http://localhost:4200/ in your browser
 
 
 ## Learn More

samples/charts/category-chart/annotations-highlighting/ReadMe.md

@@ -21,28 +21,36 @@ This folder contains Angular application with example of Annotations Highlightin
     </body>
 </html>
 
+## Branches
+
+> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-angular-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-angular-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
+
 ## Instructions
 
-To set up this project locally, execute these commands:
+Follow these instructions to run this example:
+
+
+- clone and navigate to this sample in terminal window
 
 ```
 git clone https://github.com/IgniteUI/igniteui-angular-examples.git
-cd ./igniteui-angular-examples
+git checkout master
 cd ../samples/charts/category-chart/annotations-highlighting
 ```
+<!-- cd ./igniteui-angular-examples -->
 
-open above folder in VS Code or type:
+- open above folder in VS Code or type:
 ```
 code .
 ```
 
-In terminal window, run:
+- In terminal window, run:
 ```
 npm install --legacy-peer-deps
 npm run-script start
 ```
 
-Then open http://localhost:4200/ in your browser
+- open http://localhost:4200/ in your browser
 
 
 ## Learn More