ncurses 5.7 - patch 20100911
[ncurses.git] / README.MinGW
1 -------------------------------------------------------------------------------
2 -- Copyright (c) 2008           Free Software Foundation, Inc.               --
3 --                                                                           --
4 -- Permission is hereby granted, free of charge, to any person obtaining a   --
5 -- copy of this software and associated documentation files (the             --
6 -- "Software"), to deal in the Software without restriction, including       --
7 -- without limitation the rights to use, copy, modify, merge, publish,       --
8 -- distribute, distribute with modifications, sublicense, and/or sell copies --
9 -- of the Software, and to permit persons to whom the Software is furnished  --
10 -- to do so, subject to the following conditions:                            --
11 --                                                                           --
12 -- The above copyright notice and this permission notice shall be included   --
13 -- in all copies or substantial portions of the Software.                    --
14 --                                                                           --
15 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS   --
16 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                --
17 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN --
18 -- NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,       --
19 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR     --
20 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE --
21 -- USE OR OTHER DEALINGS IN THE SOFTWARE.                                    --
22 --                                                                           --
23 -- Except as contained in this notice, the name(s) of the above copyright    --
24 -- holders shall not be used in advertising or otherwise to promote the      --
25 -- sale, use or other dealings in this Software without prior written        --
26 -- authorization.                                                            --
27 -------------------------------------------------------------------------------
28 -- $Id: README.MinGW,v 1.1 2008/12/14 19:22:16 juergen Exp $
29 -- Author: Juergen Pfeifer
30 -------------------------------------------------------------------------------
31
32 This is work in progress, but it's in an state where one can see it
33 works at least on the Windows Console.
34
35 To build ncurses for native Windows, you need the MinGW toolchain from
36 http://www.mingw.org
37
38 You should install also the MSYS package, so that you've a shell environment
39 that allows you to run the scripts, especially configure etc.
40
41 Using MinGW is a pragmatic decision, it's the easiest way to port this
42 heavily UNIX based sourcebase to native Windows. The goal is of course
43 to provide the includes, libraries and DLLs to be used with the more
44 common traditional development environments on Windows, mainly with
45 Microsoft Visual Studio.
46
47 If you start a bash from the MSYS environment, please make sure that the
48 Microsoft Development tools are in your PATH right after the MinGW
49 tools. The LIB.EXE tool is the only one needed. You need this only if 
50 you want to build DLLs that work with native Windows programs. If you 
51 don't have any Microsoft  Development tools on your machine, consider 
52 at least to get the free "Visual C++ 2008 Express Edition". 
53 It contains the LIB.EXE tool. You may also use this compiler to test 
54 writing native Windows programs using the ncurses DLLs without using 
55 MinGW then for writing apps.
56
57 Please unset the TERM environment variable, so that the Console driver
58 gets activated.
59
60 This code requires WindowsNT 5.1 or better, which means on the client
61 Windows XP or better, on the server Windows Server 2003 or better.
62
63 In order to build the DLLs, you must call
64
65    make dlls
66
67 A lot is still TODO, e.g.:
68
69   - Mouse support for the Console
70   - Wide Character support
71     The Win32Con driver should actually only use Unicode in the
72     future.
73   - Thread support (locking)
74   - A GUI console driver
75   - Support for Terminals attached via a serial port (via terminfo)
76   - Support for networked Terminal connections (via terminfo)
77
78 To support terminfo, we need to have an ioctl() simulation for the
79 serial and networked Terminals.