aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJensOwen <jens@jelo.com>2014-11-01 13:05:43 -0600
committerJensOwen <jens@jelo.com>2014-11-01 13:05:43 -0600
commitf778eabe7a4319e5bc9e552efba203c01dd0cf6f (patch)
tree72f8d5a20b81292345581d464f70c2e321d85031 /README.md
parenta9b8c07f2a4428c1fc023ee4b9e2a5b5f3a0de97 (diff)
downloadusermoji-f778eabe7a4319e5bc9e552efba203c01dd0cf6f.tar.xz
Build Direction
add link in top level readme to build info, and put a place holder in for demo/readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 26 insertions, 5 deletions
diff --git a/README.md b/README.md
index 903f1d87..06814931 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,13 @@
# Explicit GL (XGL) Ecosystem Components
-*Version 0.2, 31 Oct 2014*
+*Version 0.2, Spinning Cube, 31 Oct 2014*
-This project provides open source components for the XGL Ecosystem.
+This project provides *open source* components for the XGL Ecosystem.
-The components here are being shared with the Khronos community to provide early insights into the specification of XGL and to assists those doing prototyping at this point.
+## Introduction
+
+The components here are being shared with the Khronos community to provide
+early insights into the specification of XGL and to assists those doing
+prototyping at this point.
The following components are available:
- Proposed Reference [*ICD Loader*](https://github.com/KhronosGroup/GL-Next/tree/master/loader) (including [*Layer Management*](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md))
@@ -15,16 +19,31 @@ The following components are available:
- [Common Infrastructure](https://github.com/KhronosGroup/GL-Next/tree/master/icd/common)
- [Implementation for Intel GPUs](https://github.com/KhronosGroup/GL-Next/tree/master/icd/intel)
+## How to Build and Run
+
+This release demonstrates a spinning textured cube as an example of the
+vertical slice of XGL functionality running on Ubuntu 14.10 with an Intel
+GPU. Included are instructions for
+[building all the components](https://github.com/KhronosGroup/GL-Next/tree/master/BUILD.md)
+and
+[running the XGL spinning cube demo application](https://github.com/KhronosGroup/GL-Next/tree/master/demos/README.md).
+
+Information on how to enable the API Dump and Validation layers is in
+[layers/README.md](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md).
+
+## References
This version of the components are written based on the following preliminary specs and proposals:
- [**XGL Programers Reference**, 1 Jul 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/AMD/Explicit%20GL%20Programming%20Guide%20and%20API%20Reference.pdf)
- [**BIL**, version 1.0, revision 18](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/BIL/Specification/BIL.html)
- [**IMG's Fixed Function Proposal**, 28 Oct 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/IMG/xgl_vertex_input_description2_img.h)
- [**Valve's Loader Proposal**, 7 Oct 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/Valve/xglLayers.pptx)
+## License
This work is intended to be released as open source under a BSD-style
license once the XGL specification is public. Until that time, this work
is covered by the Khronos NDA governing the details of the XGL API.
+## Acknowledgements
While this project is being developed by LunarG, Inc; there are many other
companies and individuals making this possible: Valve Software, funding
project development; Intel Corporation, providing full hardware specifications
@@ -33,5 +52,7 @@ ARM, contributing a Chairman for this working group within Khronos; Nvidia,
providing an initial co-editor for the spec; Qualcomm for picking up the
co-editor's chair; and Khronos, for providing hosting within GitHub.
-If you have questions or comments about this driver, please post those to
-gl_common@khronos.org; or if you prefer, directly to LunarG via XGL@LunarG.com
+## Contact
+If you have questions or comments about this driver; or you would like to contribute
+directly to this effort, please contact us at XGL@LunarG.com; or if you prefer, via
+the GL Common mailing list: gl_common@khronos.org