Update README.md

diff --git a/examples/main/README.md b/examples/main/README.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..f3fbf05c8eb3bec5073be604982df0937ca5b603 100644 (file)
--- a/examples/main/README.md
+++ b/examples/main/README.md
@@ -0,0 +1,26 @@
+# main\r
+\r
+This is the main example demonstrating most of the functionality of the Whisper model.\r
+It can be used as a reference for using the `whisper.cpp` library in other projects.\r
+\r
+```\r
+./main -h\r
+\r
+usage: ./main [options] file0.wav file1.wav ...\r
+\r
+options:\r
+  -h,       --help           show this help message and exit\r
+  -s SEED,  --seed SEED      RNG seed (default: -1)\r
+  -t N,     --threads N      number of threads to use during computation (default: 4)\r
+  -o N,     --offset N       offset in milliseconds (default: 0)\r
+  -v,       --verbose        verbose output\r
+            --translate      translate from source language to english\r
+  -otxt,    --output-txt     output result in a text file\r
+  -ovtt,    --output-vtt     output result in a vtt file\r
+  -osrt,    --output-srt     output result in a srt file\r
+  -ps,      --print_special  print special tokens\r
+  -nt,      --no_timestamps  do not print timestamps\r
+  -l LANG,  --language LANG  spoken language (default: en)\r
+  -m FNAME, --model FNAME    model path (default: models/ggml-base.en.bin)\r
+  -f FNAME, --file FNAME     input WAV file path\r
+```\r