2015-08-14 23:14:05 +00:00
# dat.GUI
2013-12-18 22:24:50 +00:00
A lightweight graphical user interface for changing variables in JavaScript.
2011-04-06 19:19:12 +00:00
2013-12-18 23:51:21 +00:00
Get started with dat.GUI by reading the tutorial at http://workshop.chromeexperiments.com/examples/gui.
2011-04-06 19:19:12 +00:00
2015-08-14 23:52:41 +00:00
## Live demo
Simple live demo [is available here ](http://korczis.github.io/dat.gui/ )
2013-12-18 22:24:50 +00:00
2015-08-14 23:14:05 +00:00
## Packaged Builds
2013-12-18 22:24:50 +00:00
The easiest way to use dat.GUI in your code is by using the built source at `build/dat.gui.min.js` . These built JavaScript files bundle all the necessary dependencies to run dat.GUI.
In your `head` tag, include the following code:
```
2015-08-14 23:14:48 +00:00
< script type = "text/javascript" src = "dat.gui.js" > < / script >
2013-12-18 22:24:50 +00:00
```
2015-08-14 23:14:05 +00:00
## Directory Contents
2013-12-18 22:24:50 +00:00
2015-08-14 23:14:05 +00:00
```
├── build - Compiled source code.
├── node_modules - External node dependencies.
├── src - Source files.
├── tests - Tests.
└── webpack - Webpack config files.
```
2013-12-18 22:24:50 +00:00
2015-08-14 23:14:05 +00:00
## Building your own dat.GUI
2013-12-18 22:24:50 +00:00
In the terminal, enter the following:
```
2015-08-14 13:24:30 +00:00
$ npm run build
2013-12-18 22:24:50 +00:00
```
2015-08-14 23:14:05 +00:00
This will create a namespaced, unminified build of dat.GUI at `build/dat.gui.js`
2013-12-18 22:24:50 +00:00
2015-08-14 23:14:05 +00:00
## Thanks
2013-12-18 22:24:50 +00:00
The following libraries / open-source projects were used in the development of dat.GUI:
* [require.js ](http://requirejs.org/ )
* [Sass ](http://sass-lang.com/ )
* [node.js ](http://nodejs.org/ )
* [QUnit ](https://github.com/jquery/qunit ) / [jquery ](http://jquery.com/ )
