Update README.md (blove#1)

README.md

@@ -1,27 +1,92 @@
-# AdvancedRxjs
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.0.5.
 
-## Development server
+## Workshop Setup
 
-Run `ng serve` for a dev server. Navigate to `http:https://localhost:4200/`. The app will automatically reload if you change any of the source files.
+First, we recommend that you star this repo so you get notifications of any future updates.
 
-## Code scaffolding
+The required software for this workshop is:
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+1. Git
+2. Node.js and npm
+3. A clone of this repository and it's dependencies
 
-## Build
+### macOS
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+We chose to list the macOS instructions first, but only for alphabetical reasons. 😁
 
-## Running unit tests
+1. Git should already be installed. You should verify this by opening the terminal (Applications > Utilities > Terminal) and running the following command:
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+```bash
+git --version
+```
 
-## Running end-to-end tests
+This should indicate the version of Git that is installed on your machine.
 
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http:https://www.protractortest.org/).
+2. We recommend installing Node.js and npm using homebrew. Homebrew is a package manager for macOS, and it simplifies installing packages like node.
 
-## Further help
+If you do not have homebrew installed, you can install homebrew by executing the following in your terminal (Applications > Utilities > Terminal):
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
+```
+
+After installing homebrew, run the following in your terminal to install the latest stable version of Node.js and npm:
+
+```bash
+brew update
+brew install node
+```
+
+Verify that node was installed via the following command:
+
+```bash
+node -v
+```
+
+Verify that npm was installed via the following command:
+
+```bash
+npm -v
+```
+
+3. Finally, clone this repository locally and install the necessary dependencies.
+
+When you run the following clone command a directory named "advanced-rxjs" will be created in your current working directory. You will need to change the current working directory in the terminal to the advanced-rxjs directory using the `cd` command: http:https://www.linfo.org/cd.html.
+
+```bash
+git clone https://github.com/blove/advanced-rxjs.git
+cd advanced-rxjs
+npm install
+```
+
+The first command clones the repository, then we change directory into the newly created "advanced-rxjs" directory, and finally, we run the `npm install` command to install all of the necessary dependencies.
+
+### Windows
+
+1. Windows does not have Git installed by default. First, check if you already have the Git installed by checking your applications for "Gitbash".
+
+If the "Git Bash" application is not installed, go to [https://gitforwindows.org](https://gitforwindows.org) and download the installer.
+
+More advanced users _may_ wish to use Chocolatey, a package manager for windows, to install Git: [https://chocolatey.org/packages/git](https://chocolatey.org/packages/git). Note, if you are new to the terminal environment, and using package managers in a terminal, we do _not_ suggest you use Chocolatey. The link to gitforwindows.org above is your best bet.
+
+2. Next, install Node version 12 from [https://nodejs.org](https://nodejs.org)
+
+3. Finally, use the "Git Bash" application (not the native command prompt application) to clone the repository and install the necessary dependencies. When you run the following clone command a directory named "angular-fundamentals" will be created in your current working directory. If you want to change to another directory to place this folder, use the `cd` command: http:https://www.linfo.org/cd.html
+
+Open Git Bash and run the following commands at the prompt:
+
+```bash
+git clone https://github.com/blove/advanced-rxjs.git
+cd advanced-rxjs
+npm install
+```
+
+## Verify Installation
+
+Verify the project installation by executing the following command in the terminal on macOS or in Git Bash on Windows:
+
+```bash
+npm start
+```
+
+Then open up a browser and browse to http:https://localhost:4200 and make sure that the website is running.