Skip to content

Improved Compatibility & Docs Consistency #276

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
merged 5 commits into from
Sep 5, 2025
Merged

Improved Compatibility & Docs Consistency #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e1fab5c
Improve: Naming Rust tests
ashvardanian Sep 5, 2025
e940014
Make: MSVC-friendlier Rust builds
ashvardanian Sep 5, 2025
5b9c207
Make: Avoid `Cargo.lock` for the library
ashvardanian Sep 5, 2025
301d59c
Docs: Inconsistencies & typos
ashvardanian Sep 5, 2025
889bf25
Make: Rust 1.65 compatibility
ashvardanian Sep 5, 2025
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
1 change: 0 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ jobs:
version-file: "VERSION"
update-version-in: |
Cargo.toml:^version = "(\d+\.\d+\.\d+)"
Cargo.lock:name = "simsimd"\nversion = "(\d+\.\d+\.\d+)"
package.json:"version": "(\d+\.\d+\.\d+)"
CMakeLists.txt:VERSION (\d+\.\d+\.\d+)
update-major-version-in: |
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,7 @@ target/

# perfplot charts
*.png
\n

# Library crate: don't commit lockfile
Cargo.lock
25 changes: 16 additions & 9 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 100
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-12 100
```

To compile with the default Apple Clang on MacOS, use:
To compile with the default Apple Clang on macOS, use:

```sh
brew install openblas
Expand All @@ -63,8 +63,8 @@ cmake -D CMAKE_BUILD_TYPE=Release \
cmake --build build_release --config Release
```

On MacOS it's recommended to use Homebrew and install Clang, as opposed to "Apple Clang".
Replacing the default compiler across the entire system is not recommended on MacOS, as it may break the system, but you can pass it as an environment variable:
On macOS it's recommended to use Homebrew and install Clang, as opposed to "Apple Clang".
Replacing the default compiler across the entire system is not recommended on macOS, as it may break the system, but you can pass it as an environment variable:

```sh
brew install llvm openblas
Expand Down Expand Up @@ -124,7 +124,7 @@ Here, `-s` will output the logs.
The `-x` will stop on the first failure.
The `-Wd` will silence overflows and runtime warnings.

When building on MacOS, same as with C/C++, use non-Apple Clang version:
When building on macOS, same as with C/C++, use non-Apple Clang version:

```sh
brew install llvm
Expand Down Expand Up @@ -174,7 +174,7 @@ $ python scripts/bench_vectors.py --help


Before merging your changes you may want to test your changes against the entire matrix of Python versions USearch supports.
For that you need the `cibuildwheel`, which is tricky to use on MacOS and Windows, as it would target just the local environment.
For that you need the `cibuildwheel`, which is tricky to use on macOS and Windows, as it would target just the local environment.
Still, if you have Docker running on any desktop OS, you can use it to build and test the Python bindings for all Python versions for Linux:

```sh
Expand All @@ -184,7 +184,7 @@ cibuildwheel --platform linux # works on any OS and builds all
cibuildwheel --platform linux --archs x86_64 # 64-bit x86, the most common on desktop and servers
cibuildwheel --platform linux --archs aarch64 # 64-bit Arm for mobile devices, Apple M-series, and AWS Graviton
cibuildwheel --platform linux --archs i686 # 32-bit Linux
cibuildwheel --platform macos # works only on MacOS
cibuildwheel --platform macos # works only on macOS
cibuildwheel --platform windows # works only on Windows
```

Expand All @@ -194,7 +194,7 @@ You may need root privileges for multi-architecture builds:
sudo $(which cibuildwheel) --platform linux
```

On Windows and MacOS, to avoid frequent path resolution issues, you may want to use:
On Windows and macOS, to avoid frequent path resolution issues, you may want to use:

```sh
python -m cibuildwheel --platform windows
Expand All @@ -209,6 +209,13 @@ cargo bench
open target/criterion/report/index.html
```

To automatically detect the Minimum Supported Rust Version (MSRV):

```sh
cargo +stable install cargo-msrv
cargo msrv find --ignore-lockfile
```

## JavaScript

### NodeJS
Expand All @@ -217,7 +224,7 @@ If you don't have the environment configured, here are the [installation options

```sh
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash # Linux
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash # MacOS
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash # macOS
```

Install dependencies:
Expand All @@ -242,7 +249,7 @@ If you don't have the environment configured, here are [installation options](ht

```sh
wget -qO- https://deno.land/x/install/install.sh | sh # Linux
curl -fsSL https://deno.land/install.sh | sh # MacOS
curl -fsSL https://deno.land/install.sh | sh # macOS
irm https://deno.land/install.ps1 | iex # Windows
```

Expand Down
Loading
Loading