Skip to content

Commit fc8c07f

Browse files
authored
Update README.md
1 parent b373fb0 commit fc8c07f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,11 @@ Some tips for working with git/GitHub can be found in
3333

3434
Please also see [CONTRIBUTING.md](CONTRIBUTING.md).
3535

36-
## Quickstart to run semi-locally
36+
## Running in your local environment
37+
38+
The Prembered version of the ember-api-docs expects a folder in its root that links to the `ember-api-docs-data` folder, so you can either use the `npm run clone` script to clone the `ember-api-docs-data` repo into `ember-api-docs`, OR you can create a symbolic link to `ember-api-docs-data` from `ember-api-docs`. You might want to sym-link `ember-api-docs-data` if you are generating new versions of the docs files with `ember-jsonapi-docs`, otherwise you can probably use the clone script.
39+
40+
### Quickstart to run locally
3741

3842
Follow these instructions to run the app using publically available online data.
3943
You do not need to run [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)
@@ -43,15 +47,14 @@ locally yourself.
4347
git clone https://github.com/ember-learn/ember-api-docs.git
4448
cd ember-api-docs
4549
npm install
46-
ember serve
50+
npm run clone
51+
npm run start
4752
```
4853
View at http://localhost:4200
4954

50-
## Run fully-locally using `ember-api-docs-data`
51-
52-
The Prembered version of the ember-api-docs expects a folder in its root that links to the `ember-api-docs-data` folder, so all you need to do is create a symbolic link to ember-api-docs-data and you can see the app running locally.
55+
### Run locally with a sym-link
5356

54-
Clone all of the following repositories into the same directory so they are "siblings" on the file system
57+
Clone all of the following repositories into the same directory so they are "siblings" on the file system:
5558

5659
- This repository, `ember-api-docs`
5760
- [ember-api-docs-data](https://github.com/ember-learn/ember-api-docs-data)

0 commit comments

Comments
 (0)