vinzenz/servicepoint
0
0
Fork 0
mirror of https://github.com/cccb/servicepoint.git synced 2025-01-18 18:10:14 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

examples first, better C# installation

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-05-13 21:46:22 +02:00
parent 51685f038c
commit bca09d7336
1 changed files with 34 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -17,30 +17,6 @@ Please specify the full version including patch in your Cargo.toml until 1.0 is
Expect bugs and/or missing features in the language bindings for now. If you need something specific, open an issue or a pull request. Expect bugs and/or missing features in the language bindings for now. If you need something specific, open an issue or a pull request.
## Installation
### Rust
```bash
cargo add servicepoint2
```
### C / C++
Copy the header to your project and compile against.
You have the choice of linking statically (recommended) or dynamically.
- The C example shows how to link statically against the `staticlib` variant.
- When linked dynamically, you have to provide the `cdylib` at runtime in the _same_ version, as there are no API/ABI guarantees yet.
### C# / F#
NuGet packages are not a good way to distribute native projects ([relevant issue](https://github.com/dotnet/sdk/issues/33845)).
Because of that, there is no NuGet package you can use directly.
I recommend adding this repository as a submodule and building from source. You'll need the `cdylib` build of the native library at runtime for the relevant platform. On Linux/macOS/BSD, this should be `servicepoint2/target/release/libservicepoint2.so`.
Building the `ServicePoint2` class library automatically regenerates the BindGen folder, which means the language binding will always match your library.
## Examples ## Examples
More are available in the `examples` folder. More are available in the `examples` folder.
@ -128,6 +104,38 @@ int main(void) {
} }
``` ```
## Installation
### Rust
```bash
cargo add servicepoint2
```
### C / C++
Copy the header to your project and compile against.
You have the choice of linking statically (recommended) or dynamically.
- The C example shows how to link statically against the `staticlib` variant.
- When linked dynamically, you have to provide the `cdylib` at runtime in the _same_ version, as there are no API/ABI guarantees yet.
### C# / F#
NuGet packages are not a good way to distribute native projects ([relevant issue](https://github.com/dotnet/sdk/issues/33845)).
Because of that, there is no NuGet package you can use directly.
Including this repository as a submodule and building from source is the recommended way of using the library.
```bash
git submodule add https://github.com/kaesaecracker/servicepoint.git
git commit -m "add servicepoint submodule"
```
You can now reference `servicepoint2-bindings-cs/src/ServicePoint2.csproj` in your project.
The rust library will automatically be built.
Please provide more information in the form of an issue if you need the build to copy a different library file for your platform.
## Features ## Features
This library has multiple compression libraries as optional dependencies. This library has multiple compression libraries as optional dependencies.