diff --git a/README.md b/README.md index 288b4fb86f27d9cc3e64c8830fc3750c3a53b09e..13e4b5ea537758372667f9267e41567cfc2a547c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ +Purpose of this code: + The NOMADVR application can be used to visualize in virtual reality + different materials science datasets provided by NOMAD or final users. + Multiple platforms are supported by this code. + +Context: + NOMADVR is provided in the context of the NOMAD Center of Excellence. + Datasets from the Encyclopedia and Archive are supported by NOMADVR. + +Requirements: + -Supported virtual reality hardware: HTC Vive or Oculus Rift, GearVR, + Google Cardboard for Android, or the LRZ CAVE environment. + +Usage Instructions: + See https://www.nomad-coe.eu/the-project/graphics/VR-prototype + Subdirectories: OpenVR: Demos for HTC Vive. OculusMobile: Demos for GearVR.