Commit f9a0d2bd authored by Carsten Heinz's avatar Carsten Heinz Committed by Jaco A. Hofmann
Browse files

Extend README

parent 141cad9b
......@@ -66,14 +66,28 @@ Basic Setup
2. Build TaPaSCo: `sbt compile` (this may take a while, `sbt` needs to fetch
all dependencies etc. once).
2. Create the necessary jar files with `sbt assembly`.
4. Run TaPaSCo unit tests: `sbt test`
4. _Optional_: Run TaPaSCo unit tests: `sbt test`
5. _Optional_: Generate sample configuration file: `tapasco -n config.json`
TaPaSCo should exit immediately and `config.json` will include a full
configuration that can be read with `--configFile`, including one example
for each kind of job.
6. Build libraries and _tlkm_ kernel module: `tapasco-build-libs`
When everything completed successfully, **TaPaSCo is ready to use!**
Build a TaPaSCo design
----------------------
1. Import your kernels
* HDL flow: `tapasco import <ZIP> as <ID>`
* HLS flow: `tapasco hls <KERNELS>`
2. Create a composition: `tapasco compose [<KERNEL> x <COUNT>] @ <NUM> MHz -p <PLATFORM>`
3. Load the bitstream: `tapasco-load-bitstream <BITSTREAM>`
4. Implement your host software
* C API
* C++ API
You can get more information about commands with `tapasco help <COMMAND>`.
Acknowledgements
----------------
TaPaSCo is based on [ThreadPoolComposer][1], which was developed by us as part
......@@ -121,4 +135,4 @@ We provided pre-compiled packages for many popular Linux distributions. All pack
[Kernel Driver](https://git.esa.informatik.tu-darmstadt.de/tapasco/tapasco/-/jobs/artifacts/master/raw/tlkm/tlkm.ko?job=build_kernel_fedora_29)
[Kernel Driver Debug](https://git.esa.informatik.tu-darmstadt.de/tapasco/tapasco/-/jobs/artifacts/master/raw/tlkm/tlkm.ko?job=build_kernel_fedora_29_debug)
[Runtime (RPM)](https://git.esa.informatik.tu-darmstadt.de/tapasco/tapasco/-/jobs/artifacts/master/raw/build/tapasco-2018.2.1-Linux.rpm?job=build_tapasco_fedora_29)
[Runtime Debug (RPM)](https://git.esa.informatik.tu-darmstadt.de/tapasco/tapasco/-/jobs/artifacts/master/raw/build/tapasco-2018.2.1-Linux.rpm?job=build_tapasco_fedora_29_debug)
\ No newline at end of file
[Runtime Debug (RPM)](https://git.esa.informatik.tu-darmstadt.de/tapasco/tapasco/-/jobs/artifacts/master/raw/build/tapasco-2018.2.1-Linux.rpm?job=build_tapasco_fedora_29_debug)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment