diff --git a/docs/CHANGES.rst b/docs/CHANGES.rst index 5e41423df..86ffffd33 100644 --- a/docs/CHANGES.rst +++ b/docs/CHANGES.rst @@ -12,6 +12,7 @@ Changelog * #292 Better support for XEP-0085 Chat State Notifications. [jcbrand] * #295 Document "allow_registration". [gbonvehi] * #304 Added Polish translations. [ser] +* New Makefile.win to build in Windows environments. [gbonvehi] 0.8.6 (2014-12-07) ------------------ diff --git a/docs/source/development.rst b/docs/source/development.rst index 440e72284..cf85eea27 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -12,6 +12,8 @@ follow the instructions below to create this folder and fetch Converse's 3rd-party dependencies. .. note:: + Windows environment: We recommend installing the required tools using `Chocolatey `_ + You will need Node.js (nodejs.install), Git (git.install) and optionally to build using Makefile, GNU Make (make) If you have trouble setting up a development environment on Windows, please read `this post `_ in the mailing list.: @@ -27,6 +29,9 @@ version `here `_. Also make sure you have ``Git`` installed. `Details `_. +.. note:: + Windows users should use Chocolatey as recommended above.: + Once you have *Node.js* and *git* installed, run the following command inside the Converse.js directory: @@ -34,13 +39,18 @@ directory: make dev +On Windows you need to specify Makefile.win to be used by running: + +:: + make -f Makefile.win dev + Or alternatively, if you don't have GNU Make: :: npm install bower update - + This will first install the Node.js development tools (like Grunt and Bower) and then use Bower to install all of Converse.js's front-end dependencies.