Skip to content

Commit 4210edb

Browse files
author
Jen Weber
authored
Update Readme (#29)
* Update Readme * describe guidemaker dependency * update badge
1 parent 1266cd3 commit 4210edb

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
1-
## Ember-Cli Guides Source
1+
## ember-cli guides
22

3-
[![Build Status](https://travis-ci.org/ember-learn/cli-guides-source.svg?branch=master)](https://travis-ci.org/ember-learn/cli-guides-source)
3+
[![Build Status](https://travis-ci.org/ember-learn/cli-guides.svg?branch=master)](https://travis-ci.org/ember-learn/cli-guides-source)
44

5-
This repository is part of a Work-In-Progress project to refresh and replace the CLI guides content of [https://ember-cli.com](https://ember-cli.com).
5+
This repository holds the guides and tutorials for the [Ember CLI](https://github.com/ember-cli/ember-cli), a powerful tool that helps you create, develop, and build an Ember app.
66

7-
## Contributing
7+
To contribute to the API documentation itself, which lists properties and methods used by addons and apps, instead visit [Ember CLI](https://github.com/ember-cli/ember-cli), where the API docs are managed as code comments within the codebase.
88

9-
Do you know a thing or two about the CLI or addons? Do you _wish_ you knew a thing or do? We'd love to have your help with writing or reviewing to make sure that content is helpful to all knowledge levels. To learn more about the motivation for this, read this [RFC](https://github.com/jenweber/rfcs-1/blob/cli-guides/active/0000-cli-guides.md).
9+
This project replaces, updates, and adds to the content historically hosted at [https://ember-cli.com/](https://ember-cli.com/).
1010

11-
Overall project status and tasks that need help are tracked in [this Quest issue](https://github.com/ember-learn/cli-guides-source/issues/3). Have a read through that and the [CONTRIBUTING.md](CONTRIBUTING.md) file in order to get started.
11+
Looking for repositories for the other parts of [emberjs.com](https://emberjs.com)?
12+
Check out
13+
[guides-source](https://github.com/ember-learn/guides-source),
14+
[website](https://github.com/emberjs/website),
15+
[ember-api-docs](https://github.com/ember-learn/ember-api-docs),
16+
[super-rentals tutorial](https://github.com/ember-learn/super-rentals),
17+
[statusboard](https://github.com/ember-learn/statusboard),
18+
[deprecation-app](https://github.com/ember-learn/deprecation-app),
19+
and [styleguide](https://github.com/ember-learn/ember-styleguide).
1220

13-
As this project is pre-1.0, no content should be taken as technically authoritative.
1421

1522
## Prerequisites
1623

@@ -23,7 +30,7 @@ You will need the following things properly installed on your computer.
2330

2431
## Local Development
2532

26-
The Ember-Cli Guides is a normal Ember application so if you want to run it locally you follow the standard steps:
33+
The Ember-Cli Guides is a normal Ember application, so if you want to run it locally you follow the standard steps:
2734

2835
* Clone this repository
2936
* `cd cli-guides-source`
@@ -38,6 +45,17 @@ To run the tests you can run `npm test` in your terminal, this will run any
3845
Ember tests that have been setup but also some scripts that check the Markdown
3946
files such as the link-checker.
4047

48+
## How this app works
49+
50+
The guides content is in the form of Markdown files in the [guides](https://github.com/ember-learn/cli-guides/tree/master/guides) directory. An Ember app processes and serves the Markdown files. If you look at the `app` directory, you'll see there's not much in it! That's because most of the work is done through a dependency on [guidemaker](https://sea-region.github.com/empress/guidemaker), a static site generator created in Ember.
51+
52+
## Contributing
53+
54+
Do you know a thing or two about the CLI or addons? Do you _wish_ you knew a thing or do? We'd love to have your help with writing or reviewing to make sure that content is helpful to all knowledge levels. To learn more about the motivation for this, read this [RFC](https://github.com/jenweber/rfcs-1/blob/cli-guides/active/0000-cli-guides.md). If you're new to writing Markdown, follow [this cheat sheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf).
55+
56+
Overall project status and tasks that need help are tracked in [this Quest issue](https://github.com/ember-learn/cli-guides-source/issues/3). Have a read through that and the [CONTRIBUTING.md](CONTRIBUTING.md) file in order to get started.
57+
58+
4159
### Adding more things to the table of contents
4260

4361
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.

0 commit comments

Comments
 (0)