Merge pull request #58 from mutablelogic/v1

Updates for CLI and dockerfile

Author: djthorpe

Makefile

@@ -16,11 +16,11 @@ BUILD_DIR := build
 
 # Build flags
 BUILD_MODULE := $(shell cat go.mod | head -1 | cut -d ' ' -f 2)
-BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/whisper/version.GitSource=${BUILD_MODULE}
-BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/whisper/version.GitTag=$(shell git describe --tags --always)
-BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/whisper/version.GitBranch=$(shell git name-rev HEAD --name-only --always)
-BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/whisper/version.GitHash=$(shell git rev-parse HEAD)
-BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/whisper/version.GoBuildTime=$(shell date -u '+%Y-%m-%dT%H:%M:%SZ')
+BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/version.GitSource=${BUILD_MODULE}
+BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/version.GitTag=$(shell git describe --tags --always)
+BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/version.GitBranch=$(shell git name-rev HEAD --name-only --always)
+BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/version.GitHash=$(shell git rev-parse HEAD)
+BUILD_LD_FLAGS += -X $(BUILD_MODULE)/pkg/version.GoBuildTime=$(shell date -u '+%Y-%m-%dT%H:%M:%SZ')
 BUILD_FLAGS = -ldflags "-s -w $(BUILD_LD_FLAGS)" 
 
 # If GGML_CUDA is set, then add a cuda tag for the go ${BUILD FLAGS}

README.md

@@ -2,7 +2,7 @@
 
 Speech-to-Text in golang. This is an early development version.
 
-* `cmd` contains an OpenAI-API compatible server
+* `cmd` contains an OpenAI-API compatible service
 * `pkg` contains the `whisper` service and client
 * `sys` contains the `whisper` bindings to the `whisper.cpp` library
 * `third_party` is a submodule for the whisper.cpp source
@@ -11,6 +11,7 @@ Speech-to-Text in golang. This is an early development version.
 
 (Note: Docker images are not created yet - this is some forward planning!)
 
+You can either run the whisper service as a CLI command or in a docker container.
 There are docker images for arm64 and amd64 (Intel). The arm64 image is built for
 Jetson GPU support specifically, but it will also run on Raspberry Pi's.
 
@@ -19,14 +20,15 @@ In order to utilize a NVIDIA GPU, you'll need to install the
 
 A docker volume should be created called "whisper" can be used for storing the Whisper language
 models. You can see which models are available to download locally [here](https://huggingface.co/ggerganov/whisper.cpp).
-The following command will run the server on port 8080:
+
+The following command will run the server on port 8080 for an NVIDIA GPU:
 
 ```bash
 docker run \
   --name whisper-server --rm \
   --runtime nvidia --gpus all \ # When using a NVIDIA GPU
   -v whisper:/models -p 8080:8080 -e WHISPER_DATA=/models \
-  ghcr.io/mutablelogic/go-whisper:latest
+  ghcr.io/mutablelogic/go-whisper
 ```
 
 If you include a `-debug` flag at the end, you'll get more verbose output. The API is then
@@ -92,6 +94,11 @@ The following `Makefile` targets can be used:
 
 See all the other targets in the `Makefile` for more information.
 
+## Developing
+
+The `cmd/examples` directory contains a simple example of how to use the `whisper` package
+in your own code.
+
 ## Status
 
 Still in development. See this [issue](https://github.com/mutablelogic/go-whisper/issues/1) for