Skip to content

Prepare project for crates.io publishing #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
szymon-zadworny merged 2 commits into from
Aug 10, 2026
Merged

Prepare project for crates.io publishing #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b72d4ba
Update crate versions
szymon-zadworny Aug 10, 2026
a5bedda
Update project information
szymon-zadworny Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <https://oneapi-src.github.io/oneapi-rs/sycl_rs/>
can be found at: <https://docs.rs/sycl_rs/>

### Added

Expand Down
6 changes: 3 additions & 3 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,29 @@ 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
source /opt/intel/oneapi/setvars.sh
cargo build --workspace
```

## Quick start

List the SYCL devices visible to the runtime:

```bash
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion sycl/sycl-rs-derive/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"]

Expand Down
2 changes: 1 addition & 1 deletion sycl/sycl-rs-sys/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"]

Expand Down
6 changes: 3 additions & 3 deletions sycl/sycl-rs/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"]
Expand All @@ -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"

Expand Down