Lib/idlelib/README.txt

   1 IDLEfork README
   2 ===============
   3
   4 IDLEfork is an official experimental fork of Python's Integrated
   5 DeveLopment Environment IDLE. Worthwhile and successful changes and
   6 additions will go back into the Python distribution's IDLE at some
   7 later stage. There is no spanish inquisition.
   8
   9 As David Scherer aptly put it in the original IDLE fork README (below),
  10 "It is alpha software and might be unstable. If it breaks, you get to
  11 keep both pieces." One of the aims of IDLEfork now is for it to be able
  12 to be uncompressed into its own directory and run from there, that way
  13 you can play with (or hack on) IDLEfork without any further installation,
  14 and entirely separately from your stable python IDLE distribution.
  15
  16 If you find bugs or undesired behaviour please code nifty patches and
  17 submit them to the IDLEfork SourceForge patch manager, 8^) or let us
  18 know about it in one of the appropriate fora. See the IDLEfork home
  19 page at
  20
  21 http://idlefork.sourceforge.net
  22
  23 for details on the various ways to give input to or contact the project.
  24
  25 Please see the files NEWS.txt and ChangeLog for more up to date
  26 information on changes in this release of IDLEfork.
  27
  28
  29 Thanks for trying IDLEfork,
  30 Stephen M. Gava.
  31 <elguavas@users.sourceforge.net>
  32
  33
  34
  35 README from IDLE fork 0.7.1 :
  36 =============================
  37
  38 EXPERIMENTAL LOADER IDLE 2000-05-29
  39 -----------------------------------
  40
  41    David Scherer  <dscherer@cmu.edu>
  42
  43 This is a modification of the CVS version of IDLE 0.5, updated as of
  44 2000-03-09.  It is alpha software and might be unstable.  If it breaks,
  45 you get to keep both pieces.
  46
  47 If you have problems or suggestions, you should either contact me or
  48 post to the list at http://www.python.org/mailman/listinfo/idle-dev
  49 (making it clear that you are using this modified version of IDLE).
  50
  51 Changes:
  52
  53   The ExecBinding module, a replacement for ScriptBinding, executes
  54   programs in a separate process, piping standard I/O through an RPC
  55   mechanism to an OnDemandOutputWindow in IDLE.  It supports executing
  56   unnamed programs (through a temporary file).  It does not yet support
  57   debugging.
  58
  59   When running programs with ExecBinding, tracebacks will be clipped
  60   to exclude system modules.  If, however, a system module calls back
  61   into the user program, that part of the traceback will be shown.
  62
  63   The OnDemandOutputWindow class has been improved.  In particular,
  64   it now supports a readline() function used to implement user input,
  65   and a scroll_clear() operation which is used to hide the output of
  66   a previous run by scrolling it out of the window.
  67
  68   Startup behavior has been changed.  By default IDLE starts up with
  69   just a blank editor window, rather than an interactive window.  Opening
  70   a file in such a blank window replaces the (nonexistent) contents of
  71   that window instead of creating another window.  Because of the need to
  72   have a well-known port for the ExecBinding protocol, only one copy of
  73   IDLE can be running.  Additional invocations use the RPC mechanism to
  74   report their command line arguments to the copy already running.
  75
  76   The menus have been reorganized.  In particular, the excessively large
  77   'edit' menu has been split up into 'edit', 'format', and 'run'.
  78
  79   'Python Documentation' now works on Windows, if the win32api module is
  80   present.
  81
  82   A few key bindings have been changed: F1 now loads Python Documentation
  83   instead of the IDLE help; shift-TAB is now a synonym for unindent.
  84
  85 New modules:
  86   ExecBinding.py         Executes program through loader
  87   loader.py              Bootstraps user program
  88   protocol.py            RPC protocol
  89   Remote.py              User-process interpreter
  90   spawn.py               OS-specific code to start programs
  91
  92 Files modified:
  93   autoindent.py          ( bindings tweaked )
  94   bindings.py            ( menus reorganized )
  95   config.txt             ( execbinding enabled )
  96   editorwindow.py        ( new menus, fixed 'Python Documentation' )
  97   filelist.py            ( hook for "open in same window" )
  98   formatparagraph.py     ( bindings tweaked )
  99   idle.bat               ( removed absolute pathname )
 100   idle.pyw               ( weird bug due to import with same name? )
 101   iobinding.py           ( open in same window, EOL convention )
 102   keydefs.py             ( bindings tweaked )
 103   outputwindow.py        ( readline, scroll_clear, etc )
 104   pyshell.py             ( changed startup behavior )
 105   readme.txt             ( <Recursion on file with id=1234567> )
 106
 107 IDLE 0.5 - February 2000
 108 ------------------------
 109
 110 This is an early release of IDLE, my own attempt at a Tkinter-based
 111 IDE for Python.
 112
 113 For news about this release, see the file NEWS.txt.  (For a more
 114 detailed change log, see the file ChangeLog.)
 115
 116 FEATURES
 117
 118 IDLE has the following features:
 119
 120 - coded in 100% pure Python, using the Tkinter GUI toolkit (i.e. Tcl/Tk)
 121
 122 - cross-platform: works on Windows and Unix (on the Mac, there are
 123 currently problems with Tcl/Tk)
 124
 125 - multi-window text editor with multiple undo, Python colorizing
 126 and many other features, e.g. smart indent and call tips
 127
 128 - Python shell window (a.k.a. interactive interpreter)
 129
 130 - debugger (not complete, but you can set breakpoints, view  and step)
 131
 132 USAGE
 133
 134 The main program is in the file "idle.py"; on Unix, you should be able
 135 to run it by typing "./idle.py" to your shell.  On Windows, you can
 136 run it by double-clicking it; you can use idle.pyw to avoid popping up
 137 a DOS console.  If you want to pass command line arguments on Windows,
 138 use the batch file idle.bat.
 139
 140 Command line arguments: files passed on the command line are executed,
 141 not opened for editing, unless you give the -e command line option.
 142 Try "./idle.py -h" to see other command line options.
 143
 144 IDLE requires Python 1.5.2, so it is currently only usable with a
 145 Python 1.5.2 distribution.  (An older version of IDLE is distributed
 146 with Python 1.5.2; you can drop this version on top of it.)
 147
 148 COPYRIGHT
 149
 150 IDLE is covered by the standard Python copyright notice
 151 (http://www.python.org/doc/Copyright.html).
 152
 153 FEEDBACK
 154
 155 (removed, since Guido probably doesn't want complaints about my
 156 changes)
 157
 158 --Guido van Rossum (home page: http://www.python.org/~guido/)