Skip to content

Commit

Permalink
Updated readme.txt
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.dsource.org/projects/pyd/trunk@87 1df65b71-e716-0410-9316-ac55df2b1602
  • Loading branch information
KirkMcDonald authored and KirkMcDonald committed Jan 15, 2007
1 parent 3f23bb6 commit 42353ee
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 21 deletions.
35 changes: 15 additions & 20 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,11 @@ Welcome to Pyd!

This package is composed of two separate parts:

* Celerid - An extension to Python's Distutils that is aware of the DMD
compiler.
* Pyd - A library for D that wraps the Python API.
* CeleriD - An extension to Python's Distutils that is aware of D.
* Pyd - A library for D that wraps the Python API.

It is important to note that DMD does not yet support building dynamic
libraries on Linux, and so this package is largely only useful to Windows-
users.

Celerid is primarily written by David Rushby, and Pyd is primarily written by
Kirk McDonald. Pyd uses a number of additional libraries; see credits.txt for
CeleriD was originally written by David Rushby, and Pyd is written by Kirk
McDonald. Pyd uses a number of additional libraries; see credits.txt for
details. These libraries are contained in the "infrastructure" directory.

INSTALLATION
Expand All @@ -20,19 +15,19 @@ In the easiest case, you just need to say:

python setup.py install

while in the root directory of the project. This will place both Celerid and
Pyd in Python's site-packages directory.
while in the root directory of the project. This will place CeleriD in Python's
site-packages directory, and Pyd lives inside of CeleriD.

You may find it helpful to place both DMD and Python on your system's path. A
batch file and a Windows shortcut are helpfully provided, though you will
probably have to edit them to point to the correct path on your system:
The easiest time will be had if both D and Python are on the system's PATH.
This is not required, however:

* In pydmdvars.bat, simply edit the D_ROOT and PY_ROOT variables.
* In the "Python-DMD Command Line" shortcut's "Properties" window, edit the
"Start in:" field to point to where the batch file is located.
* On Windows, only the DMD compiler is supported. If it is not found on the
PATH, CeleriD will check the DMD_BIN environment variable.
* On Linux, only the GDC compiler is supported. If it is not found on the
PATH, CeleriD will check the GDC_BIN environment variable.

Additionally, Celerid requires D_ROOT to be set to the grandparent of the DMD
compiler executable.
Examples of using Pyd may be found in the "examples" directory. The full
documentation may be found on Pyd's website:

An example of using Celerid/Pyd may be found in the "examples" directory.
http://pyd.dsource.org

2 changes: 1 addition & 1 deletion version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2006_11_19
2006_01_14

0 comments on commit 42353ee

Please sign in to comment.