Skip to content

Commit dc11c16

Browse files
committed
Add table of contents to README
1 parent 44fa2f6 commit dc11c16

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,44 @@ On Apple Silicon, the inference runs fully on the GPU via Metal:
5555

5656
https://github.com/ggml-org/whisper.cpp/assets/1991296/c82e8f86-60dc-49f2-b048-d2fdbd6b5225
5757

58+
## Table of contents
59+
60+
- [Quick start](#quick-start)
61+
- [More audio samples](#more-audio-samples)
62+
- [Memory usage](#memory-usage)
63+
- [POWER VSX Intrinsics](#power-vsx-intrinsics)
64+
- [Quantization](#quantization)
65+
- [Core ML support](#core-ml-support)
66+
- [OpenVINO support](#openvino-support)
67+
- [NVIDIA GPU support](#nvidia-gpu-support)
68+
- [Vulkan GPU support](#vulkan-gpu-support)
69+
- [BLAS CPU support via OpenBLAS](#blas-cpu-support-via-openblas)
70+
- [Ascend NPU support](#ascend-npu-support)
71+
- [Moore Threads GPU support](#moore-threads-gpu-support)
72+
- [FFmpeg support (Linux only)](#ffmpeg-support-linux-only)
73+
- [Docker](#docker)
74+
- [Prerequisites](#prerequisites)
75+
- [Images](#images)
76+
- [Usage](#usage)
77+
- [Installing with Conan](#installing-with-conan)
78+
- [Limitations](#limitations)
79+
- [Real-time audio input example](#real-time-audio-input-example)
80+
- [Confidence color-coding](#confidence-color-coding)
81+
- [Controlling the length of the generated text segments (experimental)](#controlling-the-length-of-the-generated-text-segments-experimental)
82+
- [Word-level timestamp (experimental)](#word-level-timestamp-experimental)
83+
- [Speaker segmentation via tinydiarize (experimental)](#speaker-segmentation-via-tinydiarize-experimental)
84+
- [Karaoke-style movie generation (experimental)](#karaoke-style-movie-generation-experimental)
85+
- [Video comparison of different models](#video-comparison-of-different-models)
86+
- [Benchmarks](#benchmarks)
87+
- [`ggml` format](#ggml-format)
88+
- [Bindings](#bindings)
89+
- [XCFramework](#xcframework)
90+
- [Voice Activity Detection (VAD)](#voice-activity-detection-vad)
91+
- [Silero-VAD](#silero-vad)
92+
- [VAD Options](#vad-options)
93+
- [Examples](#examples)
94+
- [Discussions](#discussions)
95+
5896
## Quick start
5997

6098
First clone the repository:
@@ -771,7 +809,7 @@ Downloading vad model silero-v5.1.2...
771809
Done! Model silero-v5.1.2 saved in C:\Users\danie\work\ai\whisper.cpp\ggml-silero-v5.1.2.bin
772810
You can now use it like this:
773811

774-
C:\path\build\bin\Release\whisper-cli.exe -vm C:\path\ggml-silero-v5.1.2.bin --vad -m models/ggml-base.en.bin -f samples\jfk.wav
812+
C:\path\build\bin\Release\whisper-cli.exe -vm C:\path\ggml-silero-v5.1.2.bin --vad -m models\ggml-base.en.bin -f samples\jfk.wav
775813

776814
```
777815

0 commit comments

Comments
 (0)