Changeset 87 for trunk/readme.txt

Show
Ignore:
Timestamp:
01/15/07 00:38:18 (2 years ago)
Author:
KirkMcDonald
Message:

Updated readme.txt

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/readme.txt

    r40 r87  
    33This package is composed of two separate parts: 
    44 
    5 * Celerid - An extension to Python's Distutils that is aware of the DMD 
    6             compiler. 
    7 * Pyd - A library for D that wraps the Python API. 
     5  * CeleriD - An extension to Python's Distutils that is aware of D. 
     6  * Pyd - A library for D that wraps the Python API. 
    87 
    9 It is important to note that DMD does not yet support building dynamic 
    10 libraries on Linux, and so this package is largely only useful to Windows- 
    11 users. 
    12  
    13 Celerid is primarily written by David Rushby, and Pyd is primarily written by 
    14 Kirk McDonald. Pyd uses a number of additional libraries; see credits.txt for 
     8CeleriD was originally written by David Rushby, and Pyd is written by Kirk 
     9McDonald. Pyd uses a number of additional libraries; see credits.txt for 
    1510details. These libraries are contained in the "infrastructure" directory. 
    1611 
    …… 
    2116    python setup.py install 
    2217 
    23 while in the root directory of the project. This will place both Celerid and 
    24 Pyd in Python's site-packages directory. 
     18while in the root directory of the project. This will place CeleriD in Python's 
     19site-packages directory, and Pyd lives inside of CeleriD. 
    2520 
    26 You may find it helpful to place both DMD and Python on your system's path. A 
    27 batch file and a Windows shortcut are helpfully provided, though you will 
    28 probably have to edit them to point to the correct path on your system: 
     21The easiest time will be had if both D and Python are on the system's PATH. 
     22This is not required, however: 
    2923 
    30 * In pydmdvars.bat, simply edit the D_ROOT and PY_ROOT variables. 
    31 * In the "Python-DMD Command Line" shortcut's "Properties" window, edit the 
    32 "Start in:" field to point to where the batch file is located. 
     24  * On Windows, only the DMD compiler is supported. If it is not found on the 
     25    PATH, CeleriD will check the DMD_BIN environment variable. 
     26  * On Linux, only the GDC compiler is supported. If it is not found on the 
     27    PATH, CeleriD will check the GDC_BIN environment variable. 
    3328 
    34 Additionally, Celerid requires D_ROOT to be set to the grandparent of the DMD 
    35 compiler executable. 
     29Examples of using Pyd may be found in the "examples" directory. The full 
     30documentation may be found on Pyd's website: 
    3631 
    37 An example of using Celerid/Pyd may be found in the "examples" directory. 
     32http://pyd.dsource.org 
    3833