Update index.md

carstenbauer · Feb 2, 2024 · 5384e04 · 5384e04
1 parent e4b29eb
commit 5384e04
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -9,14 +9,14 @@
 
 ## Installation
 
-**Note: Only Linux is supported!**
-
 The package is registered. Hence, you can simply use
 ```
 ] add ThreadPinning
 ```
 to add the package to your Julia environment.
 
+Note that ThreadPinning.jl, specifically the pinning functionality, **only works on Linux**. On other operating systems, all pinning calls (e.g. `pinthreads`) will be no-ops.
+
 ### Prerequisites
 
 To gather information about the hardware topology of the system (e.g. sockets and memory domains), ThreadPinning.jl uses [`lscpu`](https://man7.org/linux/man-pages/man1/lscpu.1.html). The latter must therefore be available (i.e. be on `PATH`), which should automatically be the case on virtually all linux systems.