@@ -24,12 +24,40 @@ If you are not a fan of using a framework, you can create your own context
2424and just use the classes in ``demosys.opengl ``. These will give you fairly
2525straight forward ways to use VAOs, Shaders, Textures and FBOs.
2626
27+ Features
28+ --------
29+
30+ - A simple effect system based on python packages
31+ - Managment commands to create new projects and effects
32+ - Convenient wrappers for VAO, Shader, Texture, FBO
33+ - Support for the rocket sync-tracker system to create interesting keyframe data
34+ - A highly pluggable framework
35+ - Support for customm management commands
36+ - Camrea and system camera support so we can easily inspect our scene
37+ - Easy resource management system (shaders, textures)
38+ - Supports vertex, fragment and geometry shaders (tessellation soon (tm))
39+ - A geometry module for generating common mesh types
40+ - Well documented (soon (tm))
41+
42+ Requirements
43+ ------------
44+
45+ In order to use the framework it's an advantage to know the following:
46+ - Basic or intermediate Python knowledge
47+ - Basic glsl knowledge
48+ - Basic knowledge about matrix math
49+
50+ If you are missing any of these requirements, the framework can definitely be used
51+ to learn the. Zero/0 lines of code are needed to generate a project with a spinning
52+ cube and you can get started playing with things.
53+
2754Documentation
2855-------------
2956
3057Project documentation can be found at readthedocs _. Optionally you can
3158build your own docs from the ``docs `` directory.
3259
60+
3361Contributing
3462------------
3563
@@ -46,12 +74,14 @@ Known Issues
4674
4775The sound player an be a bit wonky at times on startup refusing to play
4876on some platforms. We have tried a few libraries and ended up using
49- pygame's mixer module.
77+ pygame's mixer module. (Optional setup for this)
78+
79+ Audio Requirements:
5080
51- Audio Requirements: - As the current position in the music is what all
52- draw timers are connected to, we need a library that can deliver this. -
53- Efficient and accurate seeking + pause support - Some way to extract
54- simple data from the music for visualisation
81+ - As the current position in the music is what all
82+ draw timers are connected to, we need a library that can deliver this.
83+ - Efficient and accurate seeking + pause support
84+ - Some way to extract simple data from the music for visualisation
5585
5686Libraries
5787---------
0 commit comments