chore: update readme and cargo.toml

Author: sebcrozet

.run/Check.run.xml

@@ -0,0 +1,20 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Check" type="CargoCommandRunConfiguration" factoryName="Cargo Command" nameIsGenerated="true">
+    <option name="buildProfileId" value="dev" />
+    <option name="command" value="check" />
+    <option name="workingDirectory" value="file://$PROJECT_DIR$" />
+    <envs />
+    <option name="emulateTerminal" value="true" />
+    <option name="channel" value="DEFAULT" />
+    <option name="requiredFeatures" value="true" />
+    <option name="allFeatures" value="false" />
+    <option name="withSudo" value="false" />
+    <option name="buildTarget" value="REMOTE" />
+    <option name="backtrace" value="SHORT" />
+    <option name="isRedirectInput" value="false" />
+    <option name="redirectInputPath" value="" />
+    <method v="2">
+      <option name="CARGO.BUILD_TASK_PROVIDER" enabled="true" />
+    </method>
+  </configuration>
+</component>

Cargo.toml

@@ -1,12 +1,11 @@
 [package]
 name = "stensor"
 authors = ["Sébastien Crozet <[email protected]>"]
-description = "Composable WGSL shaders for linear algebra."
-homepage = "https://wgmath.rs"
-repository = "https://github.com/dimforge/wgmath"
+description = "Cross-platform GPU tensor library with Slang and Rust."
+repository = "https://github.com/dimforge/stensor"
 version = "0.1.0"
 edition = "2024"
-license = "MIT OR Apache-2.0"
+license = "Apache-2.0"
 
 [features]
 cuda = [ "cudarc", "slang-hal/cuda" ]
@@ -38,11 +37,6 @@ anyhow = "1"
 minislang = "0.1"
 
 [patch.crates-io]
-shader-slang = { git = "https://github.com/dimforge/slang-hal", rev = "77711e8ffd0bc3ed7a0106ce59c8a4b15b81a464" }
-minislang = { git = "https://github.com/dimforge/slang-hal", rev = "77711e8ffd0bc3ed7a0106ce59c8a4b15b81a464" }
-slang-hal-derive = { git = "https://github.com/dimforge/slang-hal", rev = "77711e8ffd0bc3ed7a0106ce59c8a4b15b81a464" }
-slang-hal = { git = "https://github.com/dimforge/slang-hal", rev = "77711e8ffd0bc3ed7a0106ce59c8a4b15b81a464" }
-
 #shader-slang = { path = "../slang-rs" }
 #minislang = { path = "../slang-hal/crates/minislang" }
 #slang-hal-derive = { path = "../slang-hal/crates/slang-hal-derive" }

README.md

@@ -1,7 +1,19 @@
-# stensor − GPU Linear Algebra
-
-----
+# stensor − cross-platform GPU tensor library with Rust and Slang
 
 The goal of **stensor** (pronounced s-tensor, aka, Slang tensor) is to essentially be "[**nalgebra**](https://nalgebra.rs) on the
 gpu". It aims (but it isn’t there yet) to expose linear algebra operations (including BLAS-like and LAPACK-like
-operations) as well as geometric types (quaternions, similarities, etc.) as composable Slang shaders and kernels.
+operations) as well as geometric types (quaternions, similarities, etc.) as Slang shaders and kernels.
+
+> **Warning**
+**stensor** is still very incomplete and under heavy development and is lacking many features.
+
+See also the README of [slang-hal](https://github.com/dimforge/slang-hal/blob/main/README.md) for information on
+supported platforms.
+
+### Using Slang
+
+In order to compile and run any slang project, be sure to define the `SLANG_DIR` environment variable:
+1. Download the Slang compiler libraries for your platform: https://github.com/shader-slang/slang/releases/tag/v2025.16
+2. Unzip the downloaded directory, and use its path as value to the `SLANG_DIR` environment variable: `SLANG_DIR=/path/to/slang`.
+   Note that the variable must point to the root of the slang installation (i.e. the directory that contains `bin` and `lib`).
+   We recommend adding that as a system-wide environment variables so that it also becomes available to your IDE.