From b160fd23200a98bf33d0f9dbf595874e4cddc01a Mon Sep 17 00:00:00 2001 From: Palakis Date: Tue, 14 Nov 2017 09:44:24 +0100 Subject: [PATCH] docs: update README and BUILDING documents --- BUILDING.md | 13 +++++++++++-- README.md | 15 ++++++++++----- 2 files changed, 21 insertions(+), 7 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index ed50c857..e1046c5b 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,6 +1,6 @@ # Compiling obs-websocket ## Prerequisites -You'll need [QT 5.7.0](https://download.qt.io/official_releases/qt/5.7/5.7.0/), CMake, and a working development environment for OBS Studio installed on your computer. +You'll need [QT 5.9.0](https://download.qt.io/official_releases/qt/5.7/5.7.0/), CMake, and a working development environment for OBS Studio installed on your computer. ## Windows In cmake-gui, you'll have to set the following variables : @@ -22,7 +22,16 @@ sudo make install ``` ## OS X -*To do* +Use of the Travis macOS CI scripts is recommended. Please note that these scripts install new software and can change several settings on your system. An existing obs-studio development environment is not required, as `install-dependencies-macos.sh` will install it for you. +Of course, you're encouraged to dig through the contents of these scripts to look for issues or specificities. +``` +git clone --recursive https://github.com/Palakis/obs-websocket.git +cd obs-websocket +./CI/install-dependencies-macos.sh +./CI/build-macos.sh +./CI/package-macos.sh +``` +This will result in a ready-to-use `obs-websocket.pkg` installer in the `release` subfolder. ## Automated Builds - Windows : [![Automated Build status for Windows](https://ci.appveyor.com/api/projects/status/github/Palakis/obs-websocket)](https://ci.appveyor.com/project/Palakis/obs-websocket/history) diff --git a/README.md b/README.md index 4f1e7e2c..25d20f1e 100644 --- a/README.md +++ b/README.md @@ -41,16 +41,21 @@ See the [build instructions](BUILDING.md). In order of appearance: - [Brendan H.](https://github.com/haganbmj) : Code contributions and gooder English in the Protocol specification - [Mikhail Swift](https://github.com/mikhailswift) : Code contributions -- [Tobias Frahmer](https://github.com/Frahmer) : German translation -- [Genture](https://github.com/Genteure) : Simplified Chinese and Traditional Chinese translations -- [Larissa Gabilan](https://github.com/laris151) : Portuguese translation -- [Andy Asquelt](https://github.com/asquelt) : Polish translation -- [Marcel Haazen](https://github.com/inpothet) : Dutch translation +- [Tobias Frahmer](https://github.com/Frahmer) : German localization +- [Genture](https://github.com/Genteure) : Simplified Chinese and Traditional Chinese localizations +- [Larissa Gabilan](https://github.com/laris151) : Portuguese localization +- [Andy Asquelt](https://github.com/asquelt) : Polish localization +- [Marcel Haazen](https://github.com/inpothet) : Dutch localization - [Peter Antonvich](https://github.com/pantonvich) : Code contributions - [yinzara](https://github.com/yinzara) : Code contributions - [Chris Angelico](https://github.com/Rosuav) : Code contributions - [Guillaume "Elektordi" Genty](https://github.com/Elektordi) : Code contributions - [Marwin M](https://github.com/dragonbane0) : Code contributions +- [Logan S.](https://github.com/lsdaniel) : Code contributions +- [RainbowEK](https://github.com/RainbowEK) : Code contributions +- [RytoEX](https://github.com/RytoEX) : CI script and code contributions +- [Theodore Stoddard](https://github.com/TStod) : Code contributions +- [Philip Loche](https://github.com/PicoCentauri) : Code contributions And also: special thanks to supporters of the project!