Skip to content

Commit

Permalink
fixed lib names
Browse files Browse the repository at this point in the history
  • Loading branch information
alters-mit committed Aug 25, 2023
1 parent 677c1c5 commit 9122ef4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
include:
- os: ubuntu-latest
artifact_name: libfast_image_encoder.so
asset_name: fast_image_encoder.so
asset_name: libfast_image_encoder.so
- os: windows-latest
artifact_name: fast_image_encoder.dll
asset_name: fast_image_encoder.dll
Expand All @@ -38,5 +38,6 @@ jobs:
repo_token: ${{ secrets.TOKEN }}
file: rs/fast_image_encoder/target/release/${{ matrix.artifact_name }}
asset_name: ${{ matrix.asset_name }}
tag: ${{ github.ref }}
tag: ${{ inputs.version }}
name: ${{ inputs.version }}
overwrite: true
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,16 @@ Fast Image Encoder speeds up image encoding in two ways:

## How to add Fast Image Encoder to your program

1. [Download the latest release.](https://github.com/subalterngames/fast_image_encoder/releases/latest) You need to download `FastImageEncoder.dll` (compatible with Linux, MacOS, and Windows), *and* `fast_image_encoder.*` (for whatever platform(s) you plan to develop for). MacOS: `.dylib`, Linux: `.so`, Windows: `.dll`
2. Add the download libraries to your project.
1. [Download FastImageEncoder.dll](https://github.com/subalterngames/fast_image_encoder/releases/latest) This is the C# library. It is compatible with Linux, MacOS, and Windows.
2. [Download the platform-specific Rust library:](https://github.com/subalterngames/fast_image_encoder/releases/latest)

| Platform | Rust Library |
| -------- | ----------------------------- |
| Linux | `libfast_image_encoder.so` |
| MacOS | `libfast_image_encoder.dylib` |
| Windows | `fast_image_encoder.dll` |

3. Add the download libraries (C# *and* Rust) to your C# project.

## Examples and Benchmarks

Expand Down

0 comments on commit 9122ef4

Please sign in to comment.