Clean up example structure

Author: einarf

README.md

@@ -147,13 +147,10 @@ pywavefront.configure_logging(
 )
 ```
 
-### Example Scripts
+### Examples
 
-The `example` directory contains some basic examples using the `visualization` module
-
-* `pyglet_demo.py` : Simple textured globe
-* `pyglet_demo2.py` : Higher resolution textured globe
-* `pyglet_demo_boxes.py` : Boxes demonstrating supported vertex formats of the visualization module
+The  [examples](https://github.com/pywavefront/PyWavefront/tree/master/example)
+directory contains some basic examples using the `visualization` module and further instructions on how to run them.
 
 ### Generating a Wavefront file with Blender
 
@@ -183,7 +180,7 @@ pytest tests/test_parser.py
 
 ## Community
 
-PyWavefront Discord server: https://discord.gg/nMNjbn
+PyWavefront Discord server : https://discord.gg/nMNjbn
 
 ## Owners & Maintainers
 
@@ -195,9 +192,7 @@ PyWavefront Discord server: https://discord.gg/nMNjbn
 * ComFreek
 * Daniel Coelho
 * dav92lee
-* Einar Forselv
 * Jerek Shoemaker
-* Kurt Yoder
 * Marxlp
 * Mathieu Lamarre
 * Oliv4945
@@ -215,4 +210,4 @@ the PyWavefront Maintainers organization was created adding @einarf
 License
 -------
 
-PyWavefront is BSD-licensed; see file `LICENSE`.
+PyWavefront is [BSD-licensed](https://github.com/pywavefront/PyWavefront/blob/master/LICENSE)

example/README.md

@@ -0,0 +1,43 @@
+# Examples
+
+## Requirements
+
+```bash
+cd examples
+pip install -r requirements.txt
+
+# Run an example
+python.exe pyglet_demo_boxes.py
+```
+
+## Boxes
+
+Loads and displays 6 different cubes of the folloing vertex formats:
+
+* Only positions
+* With normals
+* With vertex color
+* With texture coordinates
+* With texture cooddinates and vertex color
+* With texture coordinates and normals
+
+```
+python boxes.py
+```
+
+## Globe Simple
+
+Renders a simple low poly globe with texture coordinates and basic lighting.
+
+```
+python globe_simple.py
+```
+
+## Globe Complex
+
+Renders a simple globe (higher resolution) with texture coordinates and basic lighting.
+
+
+```
+python globe_complex.py
+```

example/pyglet_demo_boxes.py example/boxes.pyexample/pyglet_demo_boxes.py renamed to example/boxes.py

@@ -24,12 +24,12 @@
 
 window = pyglet.window.Window(width=1280, height=720)
 
-box1 = Wavefront('box/box-V3F.obj')
-box2 = Wavefront('box/box-C3F_V3F.obj')
-box3 = Wavefront('box/box-N3F_V3F.obj')
-box4 = Wavefront('box/box-T2F_V3F.obj')
-box5 = Wavefront('box/box-T2F_C3F_V3F.obj')
-box6 = Wavefront('box/box-T2F_N3F_V3F.obj')
+box1 = Wavefront('data/box/box-V3F.obj')
+box2 = Wavefront('data/box/box-C3F_V3F.obj')
+box3 = Wavefront('data/box/box-N3F_V3F.obj')
+box4 = Wavefront('data/box/box-T2F_V3F.obj')
+box5 = Wavefront('data/box/box-T2F_C3F_V3F.obj')
+box6 = Wavefront('data/box/box-T2F_N3F_V3F.obj')
 
 rotation = 0.0
 lightfv = ctypes.c_float * 4