Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding CDN script tag to README.md? #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,21 @@

**p5.gui** magically generates a graphical user interface (sliders, color selector, etc) for each of your variables. Behind the scenes it uses other libraries such as Quicksettings (and in the future also DAT.GUI) to do all the hard work.

You currently need to include both `p5.gui.js` and `quicksettings.js` in your p5.js sketch.
You currently need to include both `p5.gui.js` and `quicksettings.js` in your p5.js sketch.

You can include the library to OpenProcessing by adding these script url:

```
https://cdn.rawgit.com/bitcraftlab/p5.gui/master/libraries/p5.gui.js
https://cdn.rawgit.com/bit101/quicksettings/master/quicksettings.js
```

or adding these script tag to your html header or p5.js Editor's `index.html`:

```html
<script src="https://cdn.rawgit.com/bitcraftlab/p5.gui/master/libraries/p5.gui.js"></script>
<script src="https://cdn.rawgit.com/bit101/quicksettings/master/quicksettings.js"></script>
```

## Usage

Expand Down