Skip to content
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.

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

Quick-start instructions for C++, Rust, and Swift #125

Open
Tafnab opened this issue Mar 25, 2024 · 4 comments
Open

Quick-start instructions for C++, Rust, and Swift #125

Tafnab opened this issue Mar 25, 2024 · 4 comments
Assignees
Labels

Comments

@Tafnab
Copy link
Contributor

Tafnab commented Mar 25, 2024

On Debian 12, cmake v. 3.25.1, builds fine. Passes all tests.

However, the make file appears to be useless so far as installing for C/C++ goes.
Having a small section detailing the purpose of the CMakeLists.txt, and how to install for each supported language would clear things up.

@ashvardanian
Copy link
Owner

Hi @Tafnab! Which Makefile are you referring to?

You can find build instructions for different environments in CONTRIBUTING.md. But if you need just the library itself, in Rust - you add a Crate dependency, and in Swift- you use the Swift Package Manager, which links directly to GitHub. Feel free to patch the README.md if you think it's worth clarifying those details further 🤗

@Tafnab
Copy link
Contributor Author

Tafnab commented Mar 26, 2024

Based on what I've seen, the cmake file is only used to build the benchmarks. For C/C++ installation, just copy the include/stringzilla/* to /usr/include/stringzilla. I'm not sure where ./c/lib.c should go on the system. Shouldn't is also go to /usr/include/stringzilla? Since a number of people just want to try out your project, I expect this would be appreciated.

So far as I can tell, when using c/lib.c, you don't need to link against a library.

I would expect that instructions for python, swift, and rust would also be appreciated. I can't write them, because I don't use those languages and don't really know what you have in mind for installation.

@ashvardanian ashvardanian self-assigned this Apr 17, 2024
@ashvardanian ashvardanian changed the title Could we get some install instructions Usage instructions for C++, Rust, and Swift Apr 17, 2024
@ashvardanian ashvardanian changed the title Usage instructions for C++, Rust, and Swift Quick-start instructions for C++, Rust, and Swift Apr 17, 2024
ashvardanian pushed a commit that referenced this issue Apr 19, 2024
## [3.8.2](v3.8.1...v3.8.2) (2024-04-19)

### Docs

* Navigation improvements ([63fadff](63fadff))
* Quickstart for bindings ([52a13e3](52a13e3)), closes [#125](#125)

### Fix

* `char_traits` of a constant type ([a709083](a709083)), closes [#144](#144)
* Detecting VBMI2 and GFNI ([eb4c38d](eb4c38d)), closes [#137](#137)
@ashvardanian
Copy link
Owner

🎉 This issue has been resolved in version 3.8.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@ashvardanian
Copy link
Owner

For C and C++ I still have a CMake script to refactor, so reopening 🤗

@ashvardanian ashvardanian reopened this Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants