Skip to content

Commit

Permalink
simpler Building Documentation section
Browse files Browse the repository at this point in the history
  • Loading branch information
vijithassar committed Jun 30, 2018
1 parent ab7aa08 commit 8abd6d8
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions developer_docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ With the server running, you should be able to open test/test.html in your favor

9. Once everything is ready, submit your changes as a [pull request](https://help.github.com/articles/creating-a-pull-request).

# Building Documentation

Inline comments in p5.js are built into the public-facing [reference manual](https://p5js.org/reference/). You can also view this locally:

```
$ npm run docs:dev
```

# Overview

This [looking inside p5.js video](http://www.luisapereira.net/teaching/looking-inside-p5/) describes the tools and files used in p5.js workflow.
Expand Down Expand Up @@ -127,13 +135,6 @@ To get started:
3. Link to the src and test files in `test.html`.
4. Run the tests with `npm run grunt`.

## Building and testing the Reference Docs & Examples

This will build the p5.js library, generate the documentation files, run a web server, and open a browser to the main documentation page.

```
npm run docs:dev
```

# Repositories

Expand Down

0 comments on commit 8abd6d8

Please sign in to comment.