summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad Davis <[email protected]>2013-09-13 12:21:12 -0700
committerBrad Davis <[email protected]>2013-09-13 12:21:12 -0700
commitd4753fd0a4fcf82c8ef6084294d785cf29446050 (patch)
treea8cbe918c71cb76423ecbc7ef984627f55be8067
parentd03b5d674d1f623a5c5ba752f4f518dcbe765ea8 (diff)
parentcacc151aea8236163af7fbb477e3be07873a4d37 (diff)
Merging down .gitignore changes
-rw-r--r--.gitignore33
-rw-r--r--README.md49
2 files changed, 67 insertions, 15 deletions
diff --git a/.gitignore b/.gitignore
index 03be30e..b3cfa0e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,11 +1,34 @@
+# The project gitignore file is primarily for specifying artifacts in
+# the Official SDK which we do not wish to track in Git, but which we
+# Should expect to exist in any directory where the official SDK has
+# been placed along with the Git repository
+
+# Please do not submit pull requests with .gitignore modifications
+# without fist opening an issue or some other dialogue to
+# ensure that a change to the .gitignore is the right thing to do.
+
+# Also, do not submit pull requests with .gitignore modifications
+# mixed in with other unrelated changes.
+
+
+Doc
LibOVR/Lib
LibOVR/Obj
+Mac_OculusWorldDemo.app/Contents/Resources
+OculusWorldDemo.app
Samples/**/Obj
Samples/**/Release
Samples/**/Debug
-Samples/OculusWorldDemo/Assets
-Mac_OculusWorldDemo.app/Contents/Resources
-Doc
Tools
-.*
-OculusWorldDemo.app
+
+# Do not include items like these that are not specific to this project.
+# .*
+# *~
+
+# If you need to exclude temp or backup files or files created your build
+# system, you should place those in a global gitignore file in your root
+# directory.
+# See: https://help.github.com/articles/ignoring-files
+
+
+
diff --git a/README.md b/README.md
index b79d26b..e317d65 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,49 @@
OculusSDK
=========
-Oculus SDK with modifications for Linux development and Java development. The
-'master' branch will attempt to track the publicly released SDK version, while
-additional branches will be used for my custom modifications.
+Oculus SDK with additional community supported features and bug-fixes.
+
+Goals
+-----
+
+* Providing new features
+ * C bindings
+ * Python bindings
+ * Java bindings
+* Providing new tools
+ * Command line diagnostics for people having trouble with Rift detection
+* Providing new sample code
+ * Alternative mechanisms for rendering the Rift distortion
+ * Sample code for the non-C++ language bindings
+* Helping developers write better or easier Oculus Rift compatible software
+
+Licensing
+---------
All code not explicitly marked with another license is made available under the
terms of the Oculus SDK license, included in this kit as LICENSE.TXT and
available online at https://developer.oculusvr.com/license and is Copyright 2013
Oculus VR, Inc.
-Currently the 'linux' branch contains modifications to the SDK that allow the
-SensorBox sample to function with my local Ubuntu 13.04 distribution. It is
-currently a work in progress and no guarantee is made that you will be able to
-compile or run the application without significant effort installing dependencies
-and or fiddling with Makefiles. Good luck!
+Branches
+--------
+
+### official
+This branch will track the SDK releases from Oculus VR. It should contain only files that are included in the official
+SDK, as well as the minimal additional files to get it to play well with GitHub. Specifically this README file for the
+uninitiated and a .gitignore file to exclude artifacts from the official SDK that we do not wish to track in GitHub.
+The latter mostly consists of the binary files distributed with the SDK and documentation or any other artifacts
+with unknown or suspect licensing that would prohibit reproduction on GitHub.
+
+### stable
+Contains features that are considered complete and safe to use.
+
+### unstable
+The tip of shared development. Contains features that may not have been merged into stable. Not guaranteed to work
+at any given time.
+
+### feature-XXX
+Feature branches for changes that will require significant time and codebase changes to function, but
+which may be being developed in a team or made available for testing to the general public.
+
-June 2013
-Brad Davis \ No newline at end of file