From 9bcf8bfa3f4e45ce474127edaf494cef969a5a7e Mon Sep 17 00:00:00 2001 From: Adam Bradley Date: Tue, 20 Oct 2015 14:29:17 +0100 Subject: [PATCH] chore(): move dev readme to scripts dir --- README.md | 28 ---------------------------- scripts/README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 28 deletions(-) create mode 100644 scripts/README.md diff --git a/README.md b/README.md index 92948d49ba..47630f5b0d 100644 --- a/README.md +++ b/README.md @@ -18,34 +18,6 @@ We are also building out a number of starter projects, including the Ionic 2 sta [https://github.com/driftyco/ionic2-starter](https://github.com/driftyco/ionic2-starter) - -### Building & Running Ionic Source - -1. `npm install` -2. `gulp watch` -3. Go to [http://localhost:8000/e2e/](http://localhost:8000/e2e/) -4. Stay cool - -### Building & Running Component Demos - -1. Clone the `ionic-site` repo in `ionic2/dist/`: `git clone git@github.com:driftyco/ionic-site.git` - * You may need to remove the existing directory first: `rm -rf ionic2/dist/ionic-site` -2. Run `gulp demos:all` from the top level directory -3. Navigate to `ionic2/dist/ionic-site` and run `npm install` -4. Run `gulp watch` in this directory -5. A browser should launch at `http://localhost:3000` at which point you can navigate to `http://localhost:3000/docs/v2/components/` -6. Any time you make a change to the demos repeat step 2 - -### Running Snapshot - -1. Install [Protractor](https://angular.github.io/protractor/#/): `npm install -g protractor` -2. Export `IONIC_SNAPSHOT_KEY` (get from someone) -3. Run `gulp snapshot` - -### Running Tests - -1. `gulp karma` - ### Distribution - [npm: ionic-framework](https://www.npmjs.com/package/ionic-framework) diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000000..bdac503eb2 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,28 @@ +# Development + +### Building & Running Ionic Source + +1. `npm install` +2. `gulp watch` +3. Go to [http://localhost:8000/e2e/](http://localhost:8000/e2e/) +4. Stay cool + +### Building & Running Component Demos + +1. Clone the `ionic-site` repo in `ionic2/dist/`: `git clone git@github.com:driftyco/ionic-site.git` + * You may need to remove the existing directory first: `rm -rf ionic2/dist/ionic-site` +2. Run `gulp demos:all` from the top level directory +3. Navigate to `ionic2/dist/ionic-site` and run `npm install` +4. Run `gulp watch` in this directory +5. A browser should launch at `http://localhost:3000` at which point you can navigate to `http://localhost:3000/docs/v2/components/` +6. Any time you make a change to the demos repeat step 2 + +### Running Snapshot + +1. Install [Protractor](https://angular.github.io/protractor/#/): `npm install -g protractor` +2. Export `IONIC_SNAPSHOT_KEY` (get from someone) +3. Run `gulp snapshot` + +### Running Tests + +1. `gulp karma`