mirror of
https://github.com/dataarts/dat.gui.git
synced 2024-12-12 04:08:27 +00:00
Improve readme
This commit is contained in:
parent
4d7cf8c79e
commit
53f1e4258d
26
CHANGELOG.md
Normal file
26
CHANGELOG.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## Changelog
|
||||||
|
|
||||||
|
### 0.6.1
|
||||||
|
* Fixed all eslint issues
|
||||||
|
|
||||||
|
### 0.6.0
|
||||||
|
* Using common.js
|
||||||
|
* Using webpack for build
|
||||||
|
* Fixed an issue with colors based on arrays - https://github.com/dataarts/dat.gui/pull/57
|
||||||
|
* Update factory.js, Step param was not used - https://github.com/dataarts/dat.gui/pull/45
|
||||||
|
|
||||||
|
### 0.5
|
||||||
|
* Moved to requirejs for dependency management.
|
||||||
|
* Changed global namespace from *DAT* to *dat* (lowercase).
|
||||||
|
* Added support for color controllers. See [Color Controllers](http://workshop.chromeexperiments.com/examples/gui/#4--Color-Controllers).
|
||||||
|
* Added support for folders. See [Folders](http://workshop.chromeexperiments.com/examples/gui/#3--Folders).
|
||||||
|
* Added support for saving named presets. See [Presets](http://workshop.chromeexperiments.com/examples/gui/examples/gui/#6--Presets).
|
||||||
|
* Removed `height` parameter from GUI constructor. Scrollbar automatically induced when window is too short.
|
||||||
|
* `dat.GUI.autoPlace` parameter removed. Use `new dat.GUI( { autoPlace: false } )`. See [Custom Placement](http://workshop.chromeexperiments.com/examples/gui/#9--Custom-Placement).
|
||||||
|
* `gui.autoListen` and `gui.listenAll()` removed. See [Updating The Display Manually](http://workshop.chromeexperiments.com/examples/gui/#11--Updating-the-Display-Manually).
|
||||||
|
* `dat.GUI.load` removed. See [Saving Values](http://workshop.chromeexperiments.com/examples/gui/#5--Saving-Values).
|
||||||
|
* Made Controller code completely agnostic of GUI. Controllers can easily be created independent of a GUI panel.
|
||||||
|
|
||||||
|
|
||||||
|
### 0.4
|
||||||
|
* Migrated from GitHub to Google Code.
|
46
README.md
46
README.md
@ -17,12 +17,14 @@ In your `head` tag, include the following code:
|
|||||||
|
|
||||||
|
|
||||||
## Directory Contents
|
## Directory Contents
|
||||||
* build: Concatenated source code.
|
|
||||||
* src: Modular code in [require.js](http://requirejs.org/) format. Also includes css, [scss](http://sass-lang.com/), and html, some of which is included during build.
|
|
||||||
* tests: [QUnit](https://github.com/jquery/qunit) test suite.
|
|
||||||
* utils: [node.js](http://nodejs.org/) utility scripts for compiling source.
|
|
||||||
|
|
||||||
----
|
```
|
||||||
|
├── build - Compiled source code.
|
||||||
|
├── node_modules - External node dependencies.
|
||||||
|
├── src - Source files.
|
||||||
|
├── tests - Tests.
|
||||||
|
└── webpack - Webpack config files.
|
||||||
|
```
|
||||||
|
|
||||||
## Building your own dat.GUI
|
## Building your own dat.GUI
|
||||||
|
|
||||||
@ -32,39 +34,7 @@ In the terminal, enter the following:
|
|||||||
$ npm run build
|
$ npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
This will create a namespaced, unminified build of dat.GUI at `build/dat.gui.main.js`
|
This will create a namespaced, unminified build of dat.GUI at `build/dat.gui.js`
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
##Change log
|
|
||||||
|
|
||||||
### 0.6.1
|
|
||||||
* Fixed all eslint issues
|
|
||||||
|
|
||||||
### 0.6.0
|
|
||||||
* Using common.js
|
|
||||||
* Using webpack for build
|
|
||||||
* Fixed an issue with colors based on arrays - https://github.com/dataarts/dat.gui/pull/57
|
|
||||||
* Update factory.js, Step param was not used - https://github.com/dataarts/dat.gui/pull/45
|
|
||||||
|
|
||||||
### 0.5
|
|
||||||
* Moved to requirejs for dependency management.
|
|
||||||
* Changed global namespace from *DAT* to *dat* (lowercase).
|
|
||||||
* Added support for color controllers. See [Color Controllers](http://workshop.chromeexperiments.com/examples/gui/#4--Color-Controllers).
|
|
||||||
* Added support for folders. See [Folders](http://workshop.chromeexperiments.com/examples/gui/#3--Folders).
|
|
||||||
* Added support for saving named presets. See [Presets](http://workshop.chromeexperiments.com/examples/gui/examples/gui/#6--Presets).
|
|
||||||
* Removed `height` parameter from GUI constructor. Scrollbar automatically induced when window is too short.
|
|
||||||
* `dat.GUI.autoPlace` parameter removed. Use `new dat.GUI( { autoPlace: false } )`. See [Custom Placement](http://workshop.chromeexperiments.com/examples/gui/#9--Custom-Placement).
|
|
||||||
* `gui.autoListen` and `gui.listenAll()` removed. See [Updating The Display Manually](http://workshop.chromeexperiments.com/examples/gui/#11--Updating-the-Display-Manually).
|
|
||||||
* `dat.GUI.load` removed. See [Saving Values](http://workshop.chromeexperiments.com/examples/gui/#5--Saving-Values).
|
|
||||||
* Made Controller code completely agnostic of GUI. Controllers can easily be created independent of a GUI panel.
|
|
||||||
|
|
||||||
|
|
||||||
### 0.4
|
|
||||||
|
|
||||||
* Migrated from GitHub to Google Code.
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
## Thanks
|
## Thanks
|
||||||
The following libraries / open-source projects were used in the development of dat.GUI:
|
The following libraries / open-source projects were used in the development of dat.GUI:
|
||||||
|
Loading…
Reference in New Issue
Block a user