dan/api_docs
1
0
Fork 0
mirror of https://github.com/danbulant/api_docs synced 2026-05-19 04:08:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Small readme improvement

Browse source
This commit is contained in:
Robert Lord 2016-01-27 16:48:16 -06:00
parent ac9cb0aef9
commit d6a7b5ff97
1 changed files with 3 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -49,22 +49,16 @@ You're going to need:
3. `cd slate`
4. Initialize and start Slate. You can either do this locally, or with Vagrant:
#### Locally
```shell
# either run this to run locally
bundle install
bundle exec middleman server
```
You can now see the docs at http://localhost:4567. Whoa! That was fast!
#### Via Vagrant
```shell
# OR run this to run with vagrant
vagrant up
```
You can now see the docs at http://localhost:4567.
You can now see the docs at http://localhost:4567. Whoa! That was fast!
Now that Slate is all set up your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/tripit/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/tripit/slate/wiki/Deploying-Slate).