Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Added how to read local docs to README #62

Merged
merged 1 commit into from

2 participants

Miles Matthias matt debergalis
Miles Matthias

It took me a little while to guess that the /docs directory was a meteor application itself, so if I wanted to read the docs locally, I needed to launch it.

I think it would be helpful to put that in the README under the Slow Start section.

matt debergalis debergalis merged commit 32266f5 into from
Miles Matthias

This is a new version of pull request #43 since I need to change what branch this commit goes into (devel not master).

This has already been approved by debergalis in pull request #43.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Apr 15, 2012
  1. Miles Matthias

    Added a note about how to read the docs locally, since it took me a w…

    milesmatthias authored
    …hile to figure out how to do it.
This page is out of date. Refresh to see the latest.
Showing with 7 additions and 0 deletions.
  1. +7 −0 README.md
7 README.md
View
@@ -57,6 +57,13 @@ will cause ```meteor``` to be in your ```PATH```.
./install.sh
meteor --help
+
+After installing, you can read the docs locally. The ```/docs``` directory is a meteor application, so simply change into the ```/docs``` directory and launch the app:
+
+ cd docs/
+ meteor
+
+You'll then be able to read the docs locally in your browser at ```http://localhost:3000/```
## Developer Resources
Something went wrong with that request. Please try again.