README.md 1.14 KB
Newer Older
1
Tapasco (TPC)!
2
=========================
3
<img src="icon/tapasco_icon.png" alt="Tapasco logo"/>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

System Requirements
-------------------
TPC is known to work in this environment:

* Intel x86_64 arch
* Fedora 20/22 / Ubuntu 14.04
* Bash Shell 4.2.x+

Other setups likely work as well, but are untested.

Prerequisites
-------------
To use TPC, you'll need working installations of

* Vivado Design Suite 2015.2 or newer
* Java SDK 7+
* sbt 0.13.x
* git

If you want to use the High-Level Synthesis flow for generating custom IP
cores, you'll also need:

* Vivado HLS 2015.2+

Check that at least the following are in your `$PATH`:

* `sbt`
* `vivado`
* `git`
* `bash`
* [`vivado_hls`]

Basic Setup
-------------------
1.  Open a terminal in the main directory of the repository and source the TPC
    setup script via `. setup.sh`.
    You need to do this every time you use TPC (or put it into your `~/.bashrc`).
2.  Build TPC: `sbt compile` (this may take a while, `sbt` needs to fetch all
    dependencies etc. once).
3.  Run TPC unit tests: `sbt test`

When the tests complete successfully, TPC is ready to use.
Read on in [Getting Started](GETTINGSTARTED.md).