celerity / celerity/SimSYCL

Add information about simsycl headers to README

Open
#41 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
40
Forks
7
PR merge metrics
No merged PRs in 30d

Description

The README currently says:

> Systems are defined by listing all devices, platforms and their runtime properties in a JSON file.
> As a starting point, you can export the built-in system definition via
> ```c++
> simsycl::write_system_config("system.json", simsycl::builtin_system);
> ```

Trying to follow these instructions gives a compiler error, because the `simsycl::` functions aren't pulled in by including ``. I had to poke around in the source to figure out that I needed to include `simsycl/system.hh` as well.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.