From d68eacb04b32b7898a778b16e9b81af8abc02470 Mon Sep 17 00:00:00 2001
From: Milan Jaros <milan.jaros@vsb.cz>
Date: Mon, 11 Nov 2019 13:06:42 +0100
Subject: [PATCH] Add README.md

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..2e6c3342
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# VRClient
+
+## Folder Structure
+* blender - Blender 2.8 source code
+* cyclesphi - static library (think client for rendering on HPC)
+* cesnet - static library (getter for camera position, setter for rendering buffer)
+* vrclient - main application
+* scripts - bash scripts for building and running of vrclient
+
+## First Build with Downloading of source code (Linux)
+* prerequisities: CMake, GCC
+* create the working folder and download and run the script: [download_vrclient.sh](scripts/download_vrclient.sh)
+
+## Build (Linux)
+* goto the working folder and run the script: [build_vrclient_gcc.sh](scripts/build_vrclient_gcc.sh)
+
+## Run (Linux)
+* goto the working folder and run the script: [run_vrclient_gcc.sh](scripts/run_vrclient_gcc.sh)
+
+## CESNET API [cesnet.h](cesnet/cesnet.h)
+```
+// camera view matrix
+void cesnet_get_camera_matrices(float view_matrix[12]);
+
+// rendering buffer - results in YUV I420 format
+void cesnet_set_render_buffer_yuv_i420(unsigned char *y, unsigned char *u, unsigned char *v);
+
+// flag for breaking of rendering/cyclesphi loop
+bool cesnet_is_required_exit();
+
+// info about resolution and base position of camera  
+void cesnet_init_info_buffer(int width, int height, float view_matrix[12]);
+```
-- 
GitLab