readme

.github/workflows/release.yml

@@ -61,7 +61,7 @@ jobs:
         uses: softprops/action-gh-release@v1
         with:
           body_path: ".github/RELEASE-TEMPLATE.md"
-          draft: true
+          # draft: true
           files: ${{env.BINARY_NAME}}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

go.mod

@@ -2,7 +2,4 @@ module QuickPiperAudiobook
 
 go 1.22.5
 
-require (
-	github.com/alecthomas/kong v0.9.0
-	golang.org/x/build v0.0.0-20240726181213-5f4836d4d20a
-)
+require github.com/alecthomas/kong v0.9.0

go.sum

@@ -1,4 +1,8 @@
+github.com/alecthomas/assert/v2 v2.6.0 h1:o3WJwILtexrEUk3cUVal3oiQY2tfgr/FHWiz/v2n4FU=
+github.com/alecthomas/assert/v2 v2.6.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k=
 github.com/alecthomas/kong v0.9.0 h1:G5diXxc85KvoV2f0ZRVuMsi45IrBgx9zDNGNj165aPA=
 github.com/alecthomas/kong v0.9.0/go.mod h1:Y47y5gKfHp1hDc7CH7OeXgLIpp+Q2m1Ni0L5s3bI8Os=
-golang.org/x/build v0.0.0-20240726181213-5f4836d4d20a h1:xuc7iWb9ktfYBESn+Q6su50SqlWz7fYxr2ZGVM9Ipuc=
-golang.org/x/build v0.0.0-20240726181213-5f4836d4d20a/go.mod h1:C12yKxWgJeykUO2lfQINDq2U/JrauqR2Rh/tQeFnU5I=
+github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc=
+github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
+github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
+github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=

main.go

@@ -104,7 +104,7 @@ func installPiper() error {
 func checkEbookConvertInstalled() error {
 	_, err := exec.LookPath("ebook-convert")
 	if err != nil {
-		return fmt.Errorf("ebook-convert not found in PATH. Please install it with your package manager")
+		return fmt.Errorf("the ebook-convert command was not found in your PATH. Please install it with your package manager")
 	}
 
 	return nil

readme.md

@@ -1,5 +1,35 @@
 # QuickPiperAudiobook
 
-**Dependencies**
+Create an audiobook for any text content with one command. 
+ - Uses any [piper](https://rhasspy.github.io/piper-samples/) model
+ - Generates all audio offline
+ - Can take in URLs or local files which contain valid PDF, txt, mobi or epub
 
-- `ebook-convert` needs to be in your PATH. (This is often bundled with [calibre](https://calibre-ebook.com/))
+
+
+## Installing
+
+Grab a prebuilt [release](https://github.com/C-Loftus/QuickPiperAudiobook/releases/)
+
+Build from source using 
+
+```sh
+go mod tidy && go build
+```
+
+## Running 
+
+```
+./QuickPiperAudiobook --help
+```
+
+## Dependencies
+
+- `ebook-convert` needs to be in your PATH. (This is often bundled with [calibre](https://calibre-ebook.com/))
+
+> [!NOTE]  
+> You don't need to have piper installed. This program manages piper and the associated models
+
+## Limitations
+
+To my knowledge, piper does not support progress output. Long book (600+ pages) may take a long time (30 min or more) to generate as audio since all computation is being done locally.