Skip to content

Commit

Permalink
Updated the Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maximilianheer committed Sep 11, 2024
1 parent 670dd4c commit e4178d2
Showing 1 changed file with 35 additions and 6 deletions.
41 changes: 35 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <any_additional_args>
$ mkdir build_sw && cd build_sw
$ cmake <path_to_cmake_config>
$ 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 <path_to_cmake_config>
$ mkdir examples_sw/build_sw && cd examples_sw/build_sw
$ cmake ../ -DEXAMPLE=<target_example>
$ 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 <any_additional_args>
~~~~

### 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 :
Expand Down

0 comments on commit e4178d2

Please sign in to comment.