From 3577ed65a2242c6a652b43b4119a08efba8ef021 Mon Sep 17 00:00:00 2001 From: Simon Eisenmann Date: Sun, 29 Jun 2014 21:51:50 +0200 Subject: [PATCH] Added hints about nodejs versions and updated docs. --- README.md | 39 ++++++++++++++++++++++++++++----------- configure.ac | 10 ++++++---- 2 files changed, 34 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index dddd2206..16d19be3 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,17 @@ The latest version of Spreed WebRTC can be found on GitHub: ## Build prerequisites - [Go](http://golang.org) >= 1.1.0 - - [NodeJS](http://nodejs.org/) >= 0.8.0 - - [Sass](http://sass-lang.com/) >= 3.2.0 - - [Compass](http://compass-style.org/) - - [Babel](http://babel.pocoo.org/) - - [po2json](https://github.com/mikeedwards/po2json) - - [autoprefixer](https://www.npmjs.org/package/autoprefixer) 1.1 + - [NodeJS](http://nodejs.org/) >= 0.6.0 - [autoconf](http://www.gnu.org/software/autoconf/) - [automake](http://www.gnu.org/software/automake/) +## Runtime dependencies + + Spreed WebRTC compiles directly to native code and has no + external runtime dependencies. See http://golang.org/doc/faq#How_is_the_run_time_support_implemented for details. + + ## Building [![Build Status](https://travis-ci.org/strukturag/spreed-webrtc.png?branch=master)](https://travis-ci.org/strukturag/spreed-webrtc) @@ -42,8 +43,7 @@ The latest version of Spreed WebRTC can be found on GitHub: Get Go external dependencies first with ``make get``. ```bash - $ make styles - $ make javascript + $ make assets $ make binary ``` @@ -72,7 +72,24 @@ The latest version of Spreed WebRTC can be found on GitHub: web client will launch. -## In place start for development +## Development + + To build styles and translations, further dependencies are required. + The source tree contains already built styles and translations, so + these are only required if you want to make changes. + + - [NodeJS](http://nodejs.org/) >= 0.10.0 + - [Sass](http://sass-lang.com/) >= 3.2.0 + - [Compass](http://compass-style.org/) + - [autoprefixer](https://www.npmjs.org/package/autoprefixer) 1.1 + - [Babel](http://babel.pocoo.org/) + - [po2json](https://github.com/mikeedwards/po2json) + + Styles can be found in src/styles. Translations are found in src/i18n. + Each folder has its own Makefile to build the corresponding files. + + +## Running server for development Copy the server.conf.in to server.conf. @@ -99,7 +116,7 @@ The latest version of Spreed WebRTC can be found on GitHub: colors. -## Production use +## Running for production Spreed WebRTC should be run through a SSL frontend proxy with support for Websockets. Example configuration for Nginx can be @@ -118,7 +135,7 @@ The latest version of Spreed WebRTC can be found on GitHub: 1. "Fork". 2. Make a feature branch. 3. Make changes. -4. Do your commits (run ``make fmt`` before commit). +4. Do your commits (run ``make fmt`` and ``make jshint`` before commit). 5. Send "pull request". diff --git a/configure.ac b/configure.ac index 38dc46f7..21f5c303 100644 --- a/configure.ac +++ b/configure.ac @@ -25,7 +25,8 @@ AC_INIT([spreed-webrtc],[unknown],[opensource@struktur.de],[],[https://github.co # minimum required versions GO_VERSION_MIN=1.1 -NODEJS_VERSION_MIN=0.8.0 +NODEJS_VERSION_MIN=0.6.0 +NODEJS_VERSION_STYLES_MIN=0.10.0 SASS_VERSION_MIN=3.2.0 AC_CONFIG_SRCDIR([src/app/spreed-webrtc-server/main.go]) @@ -67,12 +68,13 @@ AC_SUBST(GO) AC_PATH_PROGS([NODEJS],[nodejs node]) if test x"${NODEJS}" == x"" ; then - AC_MSG_WARN([No node.js. It is required to build styles and translations.]) - NODEJS=nodejs + AC_MSG_ERROR([Please install Go before trying to build spreed-webrtc.]) else NODEJS_VERSION=`$NODEJS --version | $SED 's/^v//'` AX_COMPARE_VERSION([$NODEJS_VERSION], [lt], [$NODEJS_VERSION_MIN], - [AC_MSG_WARN([Please install node.js $NODEJS_VERSION_MIN or newer before trying to build styles (found node.js $NODEJS_VERSION).])]) + [AC_MSG_ERROR([Please install node.js $NODEJS_VERSION_MIN or newer before trying to build spreed-webrtc (found node.js $NODEJS_VERSION).])]) + AX_COMPARE_VERSION([$NODEJS_VERSION], [lt], [$NODEJS_VERSION_STYLES_MIN], + [AC_MSG_WARN([Please install node.js NODEJS_VERSION_STYLES_MIN or newer before trying to build styles (found node.js $NODEJS_VERSION).])]) fi AC_SUBST(NODEJS)