cleanup file permissions from windows, add use Carp
[perl-ctypes:perl-ctypes.git] / README
1 Ctypes
2
3 Call and wrap native C functions and libraries from Perl, using only
4 Perl.
5
6 This module requires the C library libffi to run. If you're on a unix-
7 like system, you should install this via your favoured package
8 manager. If you're on Win32 (using Strawberry Perl) you should go
9 download the libffi-3.0.9 sources yourself from the following URL,
10 compile the libraries and put them somewhere your Strawberry compiler
11 toolchain will find them when it needs to. I can't remember just now
12 whether the Strawberry toolchain is sufficient to compile libffi; you
13 might be lucky.
14
15 http://sourceware.org/libffi/
16
17 Ctypes (current v0.001) is based on libffi to provide a way of calling
18 native C library functions directly from Perl, using only Perl, and
19 hence not requiring a compiler.
20
21 Of course, the Ctypes module itself is written with XS. Haven't really
22 thought that one through entirely. Perhaps we'll provide binaries? Or
23 perhaps (wonder of wonders) it could someday be rolled into Perl5 core?
24
25 INSTALLATION
26
27 This module uses ExtUtils::ModuleMaker because I couldn't see how to
28 get Module::Build to compile stuff the way I wanted. Module::Install
29 is currently still a bit limited for this fancy stuff too. So what
30 you do is:
31
32         perl Makefile.PL
33         make
34         make test
35         make install
36
37 SUPPORT AND DOCUMENTATION
38
39 After installing, you can find documentation for this module with the
40 perldoc command.
41
42     perldoc Ctypes
43
44 You can also look for information at:
45
46     RT, CPAN's request tracker
47         http://rt.cpan.org/NoAuth/Bugs.html?Dist=Ctypes
48
49     AnnoCPAN, Annotated CPAN documentation
50         http://annocpan.org/dist/Ctypes
51
52     CPAN Ratings
53         http://cpanratings.perl.org/d/Ctypes
54
55     Search CPAN
56         http://search.cpan.org/dist/Ctypes/
57
58
59 LICENSE AND COPYRIGHT
60
61 Copyright (C) 2010 Ryan Jendoubi
62
63 This program is free software; you can redistribute it and/or modify it
64 under the terms of the Perl Artistic License.
65
66 See http://dev.perl.org/licenses/ for more information.