diff --git a/CHANGELOG.md b/CHANGELOG.md index e6b1cc0..446be5c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,7 +18,7 @@ GPUs, FPGAs …) on which code can be executed, and to manage data resources and code execution on those devices. Documentation of SYCL-rs including API description, architecture, and examples -can be found at: +can be found at: ### Added diff --git a/Cargo.lock b/Cargo.lock index cd1f5c6..f43e115 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -381,7 +381,7 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" [[package]] name = "sycl-rs" -version = "0.1.0" +version = "0.0.9" dependencies = [ "allocator-api2", "bytemuck", @@ -395,7 +395,7 @@ dependencies = [ [[package]] name = "sycl-rs-derive" -version = "0.1.0" +version = "0.0.9" dependencies = [ "proc-macro-crate", "proc-macro2", @@ -405,7 +405,7 @@ dependencies = [ [[package]] name = "sycl-rs-sys" -version = "0.1.0" +version = "0.0.9" dependencies = [ "cxx", "cxx-build", diff --git a/README.md b/README.md index e23a96f..ed34465 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,22 @@ support C++17 and SYCL. ## Installation -The crates are not yet published. To build the workspace from source: +Add your required dependencies with Cargo: +```bash +cargo add sycl-rs +``` + +Make sure to source the `setvars.sh` file before building your project. + +```bash +source /opt/intel/oneapi/setvars.sh +cargo build +``` + +## Quick start + +Build the workspace from source: ```bash git clone https://github.com/oneapi-src/oneapi-rs.git cd oneapi-rs @@ -43,8 +57,6 @@ source /opt/intel/oneapi/setvars.sh cargo build --workspace ``` -## Quick start - List the SYCL devices visible to the runtime: ```bash @@ -61,7 +73,7 @@ cargo run -p sycl-rs --example kernel_launch ## Documentation -- [API documentation](https://oneapi-src.github.io/oneapi-rs/sycl_rs/) +- [API documentation](https://docs.rs/sycl_rs/) - [Examples](sycl/sycl-rs/examples) - [Contributing](CONTRIBUTING.md) - [Changelog](CHANGELOG.md) diff --git a/sycl/sycl-rs-derive/Cargo.toml b/sycl/sycl-rs-derive/Cargo.toml index 5b860e1..a7d9e92 100644 --- a/sycl/sycl-rs-derive/Cargo.toml +++ b/sycl/sycl-rs-derive/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "sycl-rs-derive" -version = "0.1.0" +version = "0.0.9" description = "Internal procedural macros for sycl-rs" publish = ["crates-io"] diff --git a/sycl/sycl-rs-sys/Cargo.toml b/sycl/sycl-rs-sys/Cargo.toml index 0ecd336..cd6e514 100644 --- a/sycl/sycl-rs-sys/Cargo.toml +++ b/sycl/sycl-rs-sys/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "sycl-rs-sys" -version = "0.1.0" +version = "0.0.9" description = "Internal SYCL FFI implementation for sycl-rs" publish = ["crates-io"] diff --git a/sycl/sycl-rs/Cargo.toml b/sycl/sycl-rs/Cargo.toml index 4f55a36..14d5e87 100644 --- a/sycl/sycl-rs/Cargo.toml +++ b/sycl/sycl-rs/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "sycl-rs" -version = "0.1.0" +version = "0.0.9" description = "Rust bindings for SYCL" documentation = "https://docs.rs/sycl-rs" keywords = ["oneapi", "sycl", "gpu"] @@ -22,8 +22,8 @@ homepage.workspace = true allocator-api2 = "0.4.0" bytemuck = "1.25.1" cxx = "1.0.194" -sycl-rs-sys = { version = "0.1.0", path = "../sycl-rs-sys" } -sycl-rs-derive = { version = "0.1.0", path = "../sycl-rs-derive" } +sycl-rs-sys = { version = "0.0.9", path = "../sycl-rs-sys" } +sycl-rs-derive = { version = "0.0.9", path = "../sycl-rs-derive" } pin-project = "1.1.13" thiserror = "2.0.18"