1Project: miniupnp
2Project web page: http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/
3github: https://github.com/miniupnp/miniupnp
4freecode: http://freecode.com/projects/miniupnp
5Author: Thomas Bernard
6Copyright (c) 2005-2014 Thomas Bernard
7This software is subject to the conditions detailed in the
8LICENSE file provided within this distribution.
9
10
11* miniUPnP Client - miniUPnPc *
12
13To compile, simply run 'gmake' (could be 'make' on your system).
14Under win32, to compile with MinGW, type "mingw32make.bat".
15MS Visual C solution and project files are supplied in the msvc/ subdirectory.
16
17The compilation is known to work under linux, FreeBSD,
18OpenBSD, MacOS X, AmigaOS and cygwin.
19The official AmigaOS4.1 SDK was used for AmigaOS4 and GeekGadgets for AmigaOS3.
20upx (http://upx.sourceforge.net) is used to compress the win32 .exe files.
21
22To install the library and headers on the system use :
23> su
24> make install
25> exit
26
27alternatively, to install into a specific location, use :
28> INSTALLPREFIX=/usr/local make install
29
30upnpc.c is a sample client using the libminiupnpc.
31To use the libminiupnpc in your application, link it with
32libminiupnpc.a (or .so) and use the following functions found in miniupnpc.h,
33upnpcommands.h and miniwget.h :
34- upnpDiscover()
35- miniwget()
36- parserootdesc()
37- GetUPNPUrls()
38- UPNP_* (calling UPNP methods)
39
40Note : use #include <miniupnpc/miniupnpc.h> etc... for the includes
41and -lminiupnpc for the link
42
43Discovery process is speeded up when MiniSSDPd is running on the machine.
44
45
46* Python module *
47
48you can build a python module with 'make pythonmodule'
49and install it with 'make installpythonmodule'.
50setup.py (and setupmingw32.py) are included in the distribution.
51
52
53Feel free to contact me if you have any problem :
54e-mail : miniupnp@free.fr
55
56If you are using libminiupnpc in your application, please
57send me an email !
58
59For any question, you can use the web forum :
60http://miniupnp.tuxfamily.org/forum/
61
62