Added README

This commit is contained in:
Stéphane Lepin
2016-10-10 00:49:53 +02:00
parent 61be350bef
commit 234bf695e4

13
README.md Normal file
View File

@ -0,0 +1,13 @@
obs-websockets
==============
OBS Studio remote control made easy.
## Build prerequisites
You need QT 5.7 (with QtWebSockets), CMake, and a working development environment for OBS Studio installed on your computer.
## How to build
You'll need to fill these CMake variables :
* QTDIR (path) : location of the Qt environment suited for your compiler and architecture
* LIBOBS_INCLUDE_DIR (path) : location of the libobs subfolder in the source code of OBS Studio
* LIBOBS_LIB (filepath) : location of the obs.lib file
* OBS_FRONTEND_LIB (filepath) : location of the obs-frontend-api.lib file