Skip to content

Commit 7152e2b

Browse files
committed
make a README
1 parent 71779c4 commit 7152e2b

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
11
## Ember-Cli Guides Source
2+
3+
This repository is part of a Work-In-Progress project to refresh the CLI guides content that currently lives at [https://ember-cli.com](ember-cli.com). The [cli-guides-app](https://github.com/ember-learn/cli-guides-source) is the structure for the markdown files in this repository.
4+
5+
As this project is pre-1.0, no content should be taken as the final word. Additional review is still pending.
6+
7+
Do you know a thing or two about the CLI or addons? We'd love to have your help with writing! Do you _wish_ you knew a thing or do? You could help us review to make sure that content is helpful to all knowledge levels. Please drop by the #-team-learning channel on the [Ember Community Slack](https://ember-community-slackin.herokuapp.com/) and `@` one of the [main contributors](https://github.com/ember-learn/cli-guides-source/graphs/contributors) to get more information.
8+
9+
## Prerequisites
10+
11+
You will need the following things properly installed on your computer.
12+
13+
* [Git](https://git-scm.com/)
14+
* [Node.js](https://nodejs.org/) (with npm)
15+
* [Ember CLI](https://ember-cli.com/)
16+
* [Google Chrome](https://google.com/chrome/)
17+
18+
## Installation
19+
20+
* `git clone <repository-url>` this repository
21+
* `cd cli-guides-app`
22+
* `npm install`
23+
24+
This will display the content of the deployed Guides markdown
25+
26+
## Local Development
27+
28+
To see what a local copy of the Guides markdown looks like:
29+
30+
* Clone the [Ember CLI Guides](https://github.com/ember-learn/cli-guides-app) App repository
31+
* link the `ember-cli-guides-source` repository by running `npm link` inside this repository, then `npm link @ember-learn/cli-guides` in the guides-app
32+
* `npm install` and `ember serve` in the guides app
33+
* Visit your app at [http://localhost:4200](http://localhost:4200).
34+
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
35+
36+
### Adding more things to the table of contents
37+
38+
See `pages.yaml` in the cli-guides-source. Whatever has a url of index will be what is shown for the top level path, like `/tutorial/`. There must be an `index.md` under each topic.
39+
40+
### Deploying
41+
42+
See instructions on the [cli-guides-app](https://github.com/ember-learn/cli-guides-source) README.

0 commit comments

Comments
 (0)