README
1Intel(R) Cilk(TM) Plus runtime library
2
3Index:
41. BUILDING
52. USING
63. DOXYGEN DOCUMENTATION
74. QUESTIONS OR BUGS
85. CONTRIBUTIONS
9
10#
11# 1. BUILDING:
12#
13
14To distribute applications that use the Intel Cilk Plus language
15extensions to non-development systems, you need to build the Intel
16Cilk Plus runtime library and distribute it with your application.
17
18To build the libcilkrts.so runtime library component, you need the
19autoconf and automake packages, which are available through your
20favorite package manager. You also need a C/C++ compiler that
21supports the Intel Cilk Plus language extensions, since the runtime
22uses Intel Cilk Plus features internally. Use either the Intel(R)
23C++ Compiler (icc command) v12.1 or later, or in GCC 4.9 or later
24(gcc command).
25
26Once you have the necessary prerequisites installed, you can use the
27following commands to create the library:
28
29% libtoolize
30% aclocal
31% automake --add-missing
32% autoconf
33% ./configure
34% make
35% make install
36
37This will produce the libcilkrts.so shared object. To install the
38library in a custom location, set the prefix while running the
39configure script:
40
41% ./configure --prefix=/your/path/to/lib
42
43#
44# 2. USING:
45#
46
47The Intel(R) C++ Compiler will automatically try to bring in the
48Intel Cilk Plus runtime in any program that uses the relevant
49features. GCC requires explicit linking of both the library and
50its dependencies (libpthread, libdl). For example:
51
52% gcc foo.c -lcilkrts -lpthread -ldl
53
54#
55# 3. DOXYGEN DOCUMENTATION:
56#
57
58The library source has Doxygen markup. Generate HTML documentation
59based on the markup by changing directory into runtime and running:
60
61% doxygen doxygen.cfg
62
63#
64# 4. QUESTIONS OR BUGS:
65#
66
67Issues with the Intel Cilk Plus runtime can be addressed in the Intel
68Cilk Plus forums:
69http://software.intel.com/en-us/forums/intel-cilk-plus/
70
71#
72# 5. CONTRIBUTIONS:
73#
74
75The Intel Cilk Plus runtime library is dual licensed. The upstream copy
76of the library is maintained via the BSD-licensed version available at:
77http://cilkplus.org/
78
79Changes to the Intel Cilk Plus runtime are welcome and should be
80contributed to the upstream version via http://cilkplus.org/.
81
82------------------------
83Intel and Cilk are trademarks of Intel Corporation in the U.S. and/or
84other countries.
85