Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nnicandro committed Feb 16, 2019
1 parent 4cb89f9 commit a9bf4cb
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,10 @@ asked to build it.

Note, =automake= must be available on your system in order to build the module.

By default a local copy of =libzmq= is built using the following configure
flags

#+BEGIN_SRC shell
--enable-drafts=yes --enable-libunwind=no --without-docs
#+END_SRC

If you would like to link your own version of =libzmq= set the environment
variables =ZMQ_CFLAGS= and =ZMQ_LIBS= to an appropriate value before running
=make=. Currently the =--enable-drafts=yes= configure flag is required.
By default a local copy of =libzmq= is built, if you would like to link your
own version of =libzmq= set the environment variables =ZMQ_CFLAGS= and
=ZMQ_LIBS= to an appropriate value before running =make=. Currently the
=--enable-drafts=yes= configure flag is required.

The default version of =libzmq= built is 4.3.1 and can be changed by specifying
the environment variable =ZMQ_VERSION=, e.g. to something like
Expand All @@ -34,6 +28,24 @@ ZMQ_VERSION=4.3.0

*** Windows

To be able to use this package on Windows, your Emacs needs to be compiled with
module support. Currently, the official versions of Emacs appear not to have
this option enabled by default so you will have to build an Emacs with module
support by following the instructions [[https://sourceforge.net/p/emacsbinw64/wiki/Build%20guideline%20for%20MSYS2-MinGW-w64%20system/][here]], which show a way to do this using
the MinGW tools. You will need to pass the =--with-modules= option to the
=configure= script when building. See the instructions below on how to install
the MinGW tools.
**** Download the pre-built libraries

You can download a tar archive containing the pre-built Windows dll files
necessary to use this package. Both an =emacs-zmq.dll= library and a v4.3.1
=libzmq.dll= are provided.

The archive can be downloaded from the [[https://github.com/dzop/emacs-zmq/releases][releases]] page on the Github project.
After downloading, extract the archive contents into the same directory as this
project then start Emacs normally and =(require 'zmq)= should work as expected.
**** Build using MinGW

It is possible to use the included build chain on Windows using the [[https://www.msys2.org/][MSYS2]] MinGW
tools.

Expand All @@ -56,10 +68,6 @@ Windows) when you are done building.

Start the build from an MSYS2 MinGW 64-bit shell via =make=.

Note that you need to have Emacs compiled =--with-modules= to be able to load
shared modules. See instructions [[https://sourceforge.net/p/emacsbinw64/wiki/Build%20guideline%20for%20MSYS2-MinGW-w64%20system/][here]] for a way to do this using the mentioned
tools.

** Testing

Run =make test= in the top level directory.
Expand Down

0 comments on commit a9bf4cb

Please sign in to comment.