Adapting README.md
@@ -118,14 +118,16 @@ It can be used for various verification scenarios like copying memory content.
### HLS Actions
The top level entity for an HLS action needs to be named `hls_action`.
-You'll also find examples for HLS actions in [./action_examples](./action_examples). For each example, the HLS action to be integrated into the SNAP framework is contained in a file `hls_<action>.cpp`. Before initiating the SNAP framework's make process, you need to create the necessary RTL files (VHDL or Verilog) out of the `hls_<action>.cpp` file. Each example contains a `Makefile` that takes care of this. In order to make sure that the resulting top level entity fits into the SNAP framework, the HLS actions top level function needs to be named `hls_action`. All RTL files generated by the example's make process will be placed into the subdirectories `vhdl` and `verilog`. The environment variable `$ACTION_ROOT` needs to point to that directory when initiating the SNAP framework's make process.
+You'll also find examples for HLS actions in [./action_examples](./action_examples). For each example, the HLS action to be integrated into the SNAP framework is contained in a file `hls_<action>.cpp`. Before initiating the SNAP framework's make process, you need to create the necessary RTL files (VHDL or Verilog) out of the `hls_<action>.cpp` file. Each example contains a `Makefile` that takes care of this. In order to make sure that the resulting top level entity fits into the SNAP framework, the HLS actions top level function needs to be named `hls_action`.
-For instance, if you want to configure the SNAP framework for integrating the HLS memcopy example contained in `$SNAP_ROOT/hardware/action_examples/hls_memcopy`, call
+The environment variable `$ACTION_ROOT` should point to a directory containing a `Makefile` for generating the RTL code from the HLS `.cpp` sources. As shown in the examples, the `Makefile` should include the file [./action_examples/hls.mk](./action_examples/hls.mk). That way the RTL code for the HLS action will be placed below the directory that `$ACTION_ROOT` points to, and the SNAP framework's make process is able to include it.
+
+For instance, if you want to configure the SNAP framework for integrating the HLS memcopy example contained in [./action_examples/hls_memcopy](./action_examples/hls_memcopy), call
```bash
- export ACTION_ROOT=$SNAP_ROOT/hardware/action_examples/hls_memcopy/vhdl
+ export ACTION_ROOT=$SNAP_ROOT/hardware/action_examples/hls_memcopy
```
-Note the trailing `/vhdl`, and make sure to call `make` from within `$SNAP_ROOT/hardware/action_examples/hls_memcopy` before calling `make config` for the SNAP framework.
+before initiating the SNAP framework's make process.
***Note*** that for the integration of HLS actions into the SNAP framework, the `$ACTION_ROOT` directory name needs to contain the term `HLS` (case doesn't matter), or the environment variable `$HLS_SUPPORT` needs to be defined and to be set to `TRUE` (case doesn't matter).
