Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-g committed Apr 9, 2016
1 parent 458a36e commit fad0951
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,37 @@
# dfe-snippets

`dfe-snippets` is a collection of building blocks for projects using Maxeler Dataflow Engines (DFEs).
It contains useful code both for the CPU side (C++) and the DFE side (MaxJ).
`dfe-snippets` is a collection of building blocks for projects using Maxeler
Dataflow Engines (DFEs). It contains useful code both for the CPU side (C++)
and the DFE side (MaxJ) as well as various benchmarking utilities:

## Requires
- library code for CPU and DFE designs ('include', 'src')
- system benchmarks for DRAM, Interconnet and Resource Usage ('test/Benchmarks')
- application benchmarks ('applications')

1. MaxCompiler 2013+
2. Compatible [Maxeler](http://www.maxeler.com/products/) hardware
3. python 2.7 (for running scripts)

## Structure

Implementations are grouped by concept (e.g. Summation, Infrastructure, Sorting) as shown below:
The structure is:

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

## Requirements

1. MaxCompiler 2013+
2. Compatible [Maxeler](http://www.maxeler.com/products/) hardware
3. python 2.7 (for running scripts)

## Using

### DFE Libraries
Expand Down

0 comments on commit fad0951

Please sign in to comment.