mirror of
https://github.com/dataarts/dat.gui.git
synced 2024-12-12 04:08:27 +00:00
47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
# dat.GUI
|
|
A lightweight graphical user interface for changing variables in JavaScript.
|
|
|
|
Get started with dat.GUI by reading the tutorial at http://workshop.chromeexperiments.com/examples/gui.
|
|
|
|
[Change Log](CHANGELOG.md)
|
|
|
|
## Packaged Builds
|
|
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:
|
|
```
|
|
<script type="text/javascript" src="dat.gui.min.js"></script>
|
|
```
|
|
|
|
## Directory Contents
|
|
|
|
```
|
|
├── build - Compiled source code.
|
|
├── node_modules - External node dependencies.
|
|
├── src - Source files.
|
|
├── tests - Tests.
|
|
└── webpack - Webpack config files.
|
|
```
|
|
|
|
## Building your own dat.GUI
|
|
|
|
In the terminal, enter the following:
|
|
|
|
```
|
|
$ npm run build
|
|
```
|
|
|
|
## npm scripts
|
|
|
|
- npm test - Run ESLint
|
|
- npm run build - Build development and production version of scripts.
|
|
- npm run dev - Build development version of script watch for changes.
|
|
|
|
This will create a namespaced, unminified build of dat.GUI at `build/dat.gui.js`
|
|
|
|
## Thanks
|
|
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/) |