diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml deleted file mode 100644 index 0a7085e..0000000 --- a/.github/workflows/pr.yml +++ /dev/null @@ -1,76 +0,0 @@ -name: Check code -on: - push: - pull_request: - workflow_dispatch: - -jobs: - rustfmt: - runs-on: ubuntu-latest - steps: - - name: Check out code into the proper directory - uses: actions/checkout@v3 - with: - submodules: 'recursive' - - - name: Cache rust - uses: Swatinem/rust-cache@v2 - - - name: Install rust - uses: dtolnay/rust-toolchain@master - with: - toolchain: stable - components: rustfmt - - - name: Check formatting - run: cargo fmt --check - - - clippy: - strategy: - fail-fast: false - matrix: - os: [ ubuntu-latest, windows-latest, macos-latest ] - rust-version: [ stable, nightly ] - runs-on: ${{ matrix.os }} - steps: - - name: Check out code into the proper directory - uses: actions/checkout@v3 - with: - submodules: 'recursive' - - - name: Cache rust - uses: Swatinem/rust-cache@v2 - - - name: Install rust - uses: dtolnay/rust-toolchain@master - with: - toolchain: ${{ matrix.rust-version }} - components: clippy - - - name: Check clippy lints - run: cargo clippy - - build: - strategy: - fail-fast: false - matrix: - os: [ ubuntu-latest, windows-latest, macos-latest ] - rust-version: [ stable, nightly ] - runs-on: ${{ matrix.os }} - steps: - - name: Check out code into the proper directory - uses: actions/checkout@v3 - with: - submodules: 'recursive' - - - name: Cache rust - uses: Swatinem/rust-cache@v2 - - - name: Install rust - uses: dtolnay/rust-toolchain@master - with: - toolchain: ${{ matrix.rust-version }} - - - name: Check build - run: cargo build -F log_backend,tracing_backend --verbose --examples diff --git a/BUILDING.md b/BUILDING.md index 0be1f8a..c0f6e91 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,23 +1,27 @@ # Running on Arch Linux + `sudo pacman -Syy llvm clang cmake` `cargo build` # Running on Windows using MSYS2 -The following are instructions for building whisper-rs on Windows using the msys2 set of compilers. +The following are instructions for building whisper-rs on Windows using the msys2 set of compilers. -1. install msys2/mingw by following [https://code.visualstudio.com/docs/cpp/config-mingw](`https://code.visualstudio.com/docs/cpp/config-mingw`) - 1. Install g++ and make within msys2 ucrt64 - - `pacman -S --needed base-devel mingw-w64-x86_64-toolchain` - 2. Add the msys2 ucrt64 bin folder to path `C:\msys64\ucrt64\bin` +1. install msys2/mingw by following [https://code.visualstudio.com/docs/cpp/config-mingw]( + `https://code.visualstudio.com/docs/cpp/config-mingw`) + 1. Install g++ and make within msys2 ucrt64 + - `pacman -S --needed base-devel mingw-w64-x86_64-toolchain` + 2. Add the msys2 ucrt64 bin folder to path `C:\msys64\ucrt64\bin` 2. Install make by running `pacman -S make` in msys2 ucrt66 3. Set rust to use msys2: by running `rustup toolchain install stable-x86_64-pc-windows-gnu` in Windows Powershell/Cmd -4. Add `.cargo/config.toml` file in the project with the following contents: +4. Add `.cargo/config.toml` file in the project with the following contents: + ``` [target.x86_64-pc-windows-gnu] linker = "C:\\msys64\\ucrt64\\bin\\gcc.exe" ar = "C:\\msys64\\ucrt64\\bin\\ar.exe" ``` + 5. Run `cargo run` in Windows Powershell/Cmd # Running on Windows using Microsoft Visual Studio C++ @@ -31,24 +35,28 @@ Make sure you have installed and in the path: - LLVM(clang) ### Instructions (for builds with `cuda` enabled) + 1. Download [CUDA](https://developer.nvidia.com/cuda-downloads?target_os=Windows) -2. Download [Visual Studio with Desktop C++ and Clang enabled](https://visualstudio.microsoft.com/de/downloads/) (see clang link below for installer walkthrough) +2. Download [Visual Studio with Desktop C++ and Clang enabled](https://visualstudio.microsoft.com/de/downloads/) (see + clang link below for installer walkthrough) 3. Download [CLANG](https://www.wikihow.com/Install-Clang-on-Windows) 4. Download [CMAKE](https://cmake.org/download/) -5. Run `where.exe clang`, then `setx LIBCLANG_PATH "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"` or something like that +5. Run `where.exe clang`, then + `setx LIBCLANG_PATH "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\x64\bin"` or something + like that 6. Restart your shell!!! 7. Cargo build # Running on M1 OSX -To build on a M1 Mac, make sure to add the following to your project's `.cargo/config.toml`: +To build on a M1 Mac, make sure to add the following to your project's `.cargo/config.toml`: ``` [target.aarch64-apple-darwin] rustflags = "-lc++ -l framework=Accelerate" ``` -See https://github.com/tazz4843/whisper-rs/pull/2 for more information. +See https://codeberg.org/tazz4843/whisper-rs/pulls/2 for more information. You also need to have CMake installed. You can obtain this using homebrew: diff --git a/Cargo.toml b/Cargo.toml index 8365e48..da2af42 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,7 +9,7 @@ edition = "2021" description = "Rust bindings for whisper.cpp" license = "Unlicense" documentation = "https://docs.rs/whisper-rs" -repository = "https://github.com/tazz4843/whisper-rs" +repository = "https://codeberg.org/tazz4843/whisper-rs" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README.md b/README.md index 913c434..f658aee 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Rust bindings to [whisper.cpp](https://github.com/ggerganov/whisper.cpp/) ## Usage ```bash -git clone --recursive https://github.com/tazz4843/whisper-rs.git +git clone --recursive https://codeberg.org/tazz4843/whisper-rs.git cd whisper-rs diff --git a/sys/Cargo.toml b/sys/Cargo.toml index adbc89c..75a7a0c 100644 --- a/sys/Cargo.toml +++ b/sys/Cargo.toml @@ -5,7 +5,7 @@ edition = "2021" description = "Rust bindings for whisper.cpp (FFI bindings)" license = "Unlicense" documentation = "https://docs.rs/whisper-rs-sys" -repository = "https://github.com/tazz4843/whisper-rs" +repository = "https://codeberg.org/tazz4843/whisper-rs" links = "whisper" include = [ "whisper.cpp/bindings/javascript/package-tmpl.json",