Skip to content

Commit

Permalink
Update README.md with copyright and license info
Browse files Browse the repository at this point in the history
Enyo-DCO-1.1-Signed-Off-By: Ben Combee (ben.combee@lge.com)
  • Loading branch information
Ben Combee committed Mar 7, 2014
1 parent cfbd8bf commit aaef243
Showing 1 changed file with 27 additions and 10 deletions.
37 changes: 27 additions & 10 deletions README.md
@@ -1,5 +1,4 @@
Enyo 2 Sampler
==============
# Enyo 2 Sampler

A cross-platform application for viewing Enyo 2 samples from all its various libraries.

Expand All @@ -21,38 +20,56 @@ Since the app AJAX's in the JavaScript and CSS source files for the viewer, a fe
* Using this scheme, more than one sample .js file may be situated in the same folder, where they all share a sample.css file.
* When deploying the app, change the `sourcePath` variable in `assets/manifest.json` to point to a root directory containing un-minified versions of the `enyo` and `lib` directories (containing at least the samples).

URL Parameters
==============
## URL Parameters

The sampler can take additional parameters on the URL, added as arguments after a '?' character.

## addSamples=<path>[,<path>...]
### addSamples=<path>[,<path>...]

This provides one or more additional paths from which to load samples. The path should be to a manifest.json
hosted in the new collection's folder. Sampler will also try to load a package.js from the same folder
to pull in the sample source. You can use this when testing a library to load its samples into the system
without having to add them to the sampler source. These paths are saved into local storage so they don't
have to be referenced in the future.

## sourcePath=<path>
### sourcePath=<path>

This sets a path to load sample source from instead of the default manifest.
This paths is saved into local storage so it doesn't have to be referenced in the future.

## extras=1
### extras=1

This enables test mode, where you can go through each sample one-by-one. It also lets you modify
the addSamples and sourcePath directly via a settings GUI and gives access to BrowserScope
test recording.

## reset=1
### reset=1

This clears previous paramameters stored in local storage.

Benchmarking
============
## Benchmarking

There are a couple of alternate index.html files that will load all of the standard samples and run them
as a JavaScript benchmark. speedTest.html will load the minified source, while speedTestDebug.html
loads the full source from the trees. Output of benchmark results goes to the debug console.

## Copyright and License Information

Unless otherwise specified, all content, including all source code files and
documentation files in this repository are:

Copyright (c) 2012-2014 LG Electronics

Unless otherwise specified or set forth in the NOTICE file, all content,
including all source code files and documentation files in this repository are:
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this content except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

0 comments on commit aaef243

Please sign in to comment.