upgrade to version 2 of examples

pixijs · Aug 24, 2016 · 5ddff68 · 5ddff68
1 parent bf5dd8a
commit 5ddff68
Show file tree

Hide file tree

Showing 1,496 changed files with 191,188 additions and 27,720 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/Pixi_examples.jpg b/Pixi_examples.jpg
diff --git a/README.md b/README.md
@@ -1,32 +1,29 @@
-# pixi-examples
+# Pixi examples guidelines: #
 
-Repository for the pixi.js v3 examples, available online [here](ghio).
+<<<<<<< HEAD
+This is the new repository for the pixi examples.
+In the previous one, each example was a JavaScript file, we moved away from this and it is now an HTML file that can be opened on its own.
+=======
+Repository for the pixi.js v3 examples, available online [here](https://pixijs.github.io/examples/).
+>>>>>>> origin/master
 
-## Running
+The iframe that displays the examples is **800 * 600**, consequently please avoid creating a renderer that is larger than these dimensions.
 
-You can view the examples online [here][ghio]. If you want to run it locally you can clone the repository
-or download the zip file. Then just run a server pointing to the root of this repo.
 
-For example using the node [http-server][httpserver] module:
+## How to run the project ##
 
-```js
-git clone git@github.com:pixijs/examples.git
-cd examples/
+This micro-site is built using HTML and jQuery and can be run on your local server without additional requirements.
 
-npm i && npm start
-```
+## Project structure ##
 
-## Contributing
+All the examples are stored in the ``` required/examples ``` folder and loaded via the ``` manifest.json ``` file.
 
-Ideally you will need to have [node][node] setup on your machine.
+All the assets are stored in ``` required/examples/assets ```.
 
-Then you can add a new example, modify the section's `_details.json`, and rebuild the manifest file:
+Every sub-folder in the examples folder corresponds to a sub-menu in the website's sidebar.
 
-```js
-node generateManifest.js
-```
-Your local copy of the website should then be updated automatically.
+## How to create an example ##
 
-[node]: http://nodejs.org/
-[ghio]: http://pixijs.github.io/examples
-[httpserver]: https://www.npmjs.com/package/http-server
+You can use the basic example as a template, it is located in ``` required/examples/basics/basic.html ```.
+All you need to do is copy and paste this file to where you think your example belongs.
+You can then come back to the browser and navigate to your file and start changing it.
diff --git a/_assets2/bunnies/square_blue.png b/_assets2/bunnies/square_blue.png
diff --git a/_assets/bunny_square.png → _assets2/bunnies/square_green.png b/_assets/bunny_square.png → _assets2/bunnies/square_green.png