Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-g committed Jan 21, 2016
1 parent 0ee0d9c commit 3612e04
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,13 @@ Implementations are grouped by concept (e.g. Summation, Infrastructure, Sorting)

```
scripts/ ---> Useful scripts
concept1/
implementation1/
src/ ---> source code
build ---> build directory
include/ ---> Header only C++ libraries
src/ ---> MaxJ libraries
test/ ---> Test projects, benchmarks, etc.
concept1/
implementation1/
src/ ---> source code
build ---> build directory
```

## Using
Expand All @@ -36,11 +39,13 @@ You should then be able to import any class using the fully qualified name. For
```
// A Maxeler DFE kernel
import com.custom_computing_ic.dfe_snippets.blas.DenseBlasLib;
import com.custom_computing_ic.dfe_snippets.blas.DenseBlasLib;
class MyKernel extends Kernel {...}
```

__Note__ Use a full, absolute path for dfe-snippets to avoid compilation issues.

### CPU Libraries

We also provide a number of utilities for CPU code. These are header only libraries, so no compilation is required.
Expand All @@ -58,6 +63,8 @@ int main() {
}
```

__Note__ You may also have to add the `-std=c++11` flag to `CFLAGS` to ensure C++11 support is enabled.

## Creating new projects

Use `create.py -h` for a list of available options.
Expand Down

0 comments on commit 3612e04

Please sign in to comment.