Add support for extension modules in 3.0 deprection command.
[python.git] / PC / readme.txt
blobb5a5a8711861b89b951a678cf0cb1b29fb9b23aa
1 Welcome to the "PC" subdirectory of the Python distribution
2 ***********************************************************
4 This "PC" subdirectory contains complete project files to make
5 several older PC ports of Python, as well as all the PC-specific
6 Python source files.  It should be located in the root of the
7 Python distribution, and there should be directories "Modules",
8 "Objects", "Python", etc. in the parent directory of this "PC"
9 subdirectory.  Be sure to read the documentation in the Python
10 distribution.
12 Python requires library files such as string.py to be available in
13 one or more library directories.  The search path of libraries is
14 set up when Python starts.  To see the current Python library search
15 path, start Python and enter "import sys" and "print sys.path".
17 All PC ports use this scheme to try to set up a module search path:
19   1) The script location; the current directory without script.
20   2) The PYTHONPATH variable, if set.
21   3) For Win32 platforms (NT/95), paths specified in the Registry.
22   4) Default directories lib, lib/win, lib/test, lib/tkinter;
23      these are searched relative to the environment variable
24      PYTHONHOME, if set, or relative to the executable and its
25      ancestors, if a landmark file (Lib/string.py) is found ,
26      or the current directory (not useful).
27   5) The directory containing the executable.
29 The best installation strategy is to put the Python executable (and
30 DLL, for Win32 platforms) in some convenient directory such as
31 C:/python, and copy all library files and subdirectories (using XCOPY)
32 to C:/python/lib.  Then you don't need to set PYTHONPATH.  Otherwise,
33 set the environment variable PYTHONPATH to your Python search path.
34 For example,
35    set PYTHONPATH=.;d:\python\lib;d:\python\lib\win;d:\python\lib\dos-8x3
37 There are several add-in modules to build Python programs which use
38 the native Windows operating environment.  The ports here just make
39 "QuickWin" and DOS Python versions which support a character-mode
40 (console) environment.  Look in www.python.org for Tkinter, PythonWin,
41 WPY and wxPython.
43 To make a Python port, start the Integrated Development Environment
44 (IDE) of your compiler, and read in the native "project file"
45 (or makefile) provided.  This will enable you to change any source
46 files or build settings so you can make custom builds.
48 pyconfig.h    An important configuration file specific to PC's.
50 config.c    The list of C modules to include in the Python PC
51             version.  Manually edit this file to add or
52             remove Python modules.
54 testpy.py   A Python test program.  Run this to test your
55             Python port.  It should produce copious output,
56             ending in a report on how many tests were OK, how many
57             failed, and how many were skipped.  Don't worry about
58             skipped tests (these test unavailable optional features).
61 Additional files and subdirectories for 32-bit Windows
62 ======================================================
64 python_nt.rc   Resource compiler input for python15.dll.
66 dl_nt.c, import_nt.c
67                Additional sources used for 32-bit Windows features.
69 getpathp.c     Default sys.path calculations (for all PC platforms).
71 dllbase_nt.txt A (manually maintained) list of base addresses for
72                various DLLs, to avoid run-time relocation.
74 example_nt     A subdirectory showing how to build an extension as a
75                DLL.
77 Legacy support for older versions of Visual Studio
78 ==================================================
79 The subdirectories VC6, VS7.1 and VS8.0 contain legacy support older
80 versions of Microsoft Visual Studio. See PCbuild/readme.txt.
82 EMX development tools for OS/2
83 ==============================
85 See os2emx/readme.txt. This platform is maintained by Andrew MacIntyre.
87 IBM VisualAge C/C++ for OS/2
88 ============================
90 See os2vacpp/readme.txt.  This platform is supported by Jeff Rush.
92 NOTE: Support for os2vacpp may be dropped in the near future. Please move
93       to EMX.
95 Note for Windows 3.x and DOS users
96 ==================================
98 Neither Windows 3.x nor DOS is supported any more.  The last Python
99 version that supported these was Python 1.5.2; the support files were
100 present in Python 2.0 but weren't updated, and it is not our intention
101 to support these platforms for Python 2.x.