diff --git a/README.md b/README.md index 896fdbd0..ab68cd93 100644 --- a/README.md +++ b/README.md @@ -87,21 +87,50 @@ This default image is built with `-DEXAMPLE=static`. ### Build `SW` -After the bitstream is loaded, the driver can be inserted once for the initial static image. +Provided software applications (as well as any other) can be built with the following commands: ~~~~ -$ cd driver && make -$ insmod coyote_drv.ko +$ mkdir build_sw && cd build_sw +$ cmake +$ make ~~~~ -Provided software applications (as well as any other) can be built with the following commands: +Similar to building the HW, it makes sense to build within the `examples_sw` directory for direct access to the provided `CMakeLists.txt`: ~~~~ -$ mkdir build_sw && cd build_sw -$ cmake +$ mkdir examples_sw/build_sw && cd examples_sw/build_sw +$ cmake ../ -DEXAMPLE= $ make ~~~~ +### Build `Driver` + +After the bitstream is loaded, the driver can be inserted once for the initial static image. + +~~~~ +$ cd driver && make +$ insmod coyote_drv.ko +~~~~ + +### Provided examples +Coyote already comes with a number of pre-configured example applications that can be used to test the shell-capabilities and systems performance or start own developments around networking or memory-offloading. The following list (to be continued in the future) should give you an overview on the existent example apps, how to set them up in hard- and software and how to use them: + +#### kmeans + +#### multithreading + +#### perf_fpga + +#### perf_local + +#### rdma_service + +#### reconfigure_shell + +#### streaming_service + +#### tcp_iperf + ## Publication #### If you use Coyote, cite us :