Skip to content

Commit ad3c54f

Browse files
committed
Updating README.md
1 parent 96b44fd commit ad3c54f

1 file changed

Lines changed: 54 additions & 1 deletion

File tree

README.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,57 @@
11
arrayfire_java
22
==============
33

4-
Java wrapper for ArrayFire
4+
This repository contains the files required to use ArrayFire from Java.
5+
6+
Prerequisites
7+
---------------
8+
9+
- The latest version of ArrayFire. You can [download here](http://www.accelereyes.com/download_arrayfire)
10+
- All the pre-requisites for ArrayFire still apply.
11+
12+
- The latest version of `JAVA SDK`
13+
14+
- `make`
15+
16+
- `Linux`. `Windows` and `OSX` support coming soon.
17+
18+
Contents
19+
---------------
20+
21+
- `src/`: Contains the source files for the ArrayFire Java wrapper
22+
- `java_wrapper.cpp` The JNI wrapper file
23+
- `java_wrapper.h` The JNI API definitions
24+
25+
- `com/`: Contains the Java source files implementing `Array` and `Image` classes
26+
27+
- `lib/`, `lib64/`: The location where the JNI library is stored
28+
29+
- `examples`: contains a few examples demonstrating the usage
30+
31+
Usage
32+
----------------
33+
34+
After you the necessary pre-requisites, edit the following paramets
35+
36+
- Open `Makefile` and change `AF_PATH` to the right location
37+
38+
39+
### Linux
40+
41+
- To build the JNI Wrapper for ArrayFire use
42+
- `make cuda` to build using CUDA
43+
- `make opencl` to build using OpenCL
44+
45+
- To build the examples do one of the following from the examples directory
46+
- `make cuda run ` to use build and run examples using CUDA
47+
- `make opencl run` to use build and run examples using OpenCL
48+
49+
Documentation
50+
---------------
51+
- TODO
52+
53+
License
54+
---------------
55+
56+
- Please check the LICENSE file in the root directory
57+

0 commit comments

Comments
 (0)