diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 7128446..00bc9d0 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -2,9 +2,9 @@ name: Rust on: push: - branches: [ "main" ] + branches: [ "master" ] pull_request: - branches: [ "main" ] + branches: [ "master" ] env: CARGO_TERM_COLOR: always diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5dca604 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Logan King + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index e69f56c..3434dd9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,59 @@ # desk-talk +Transcription for your desktop. + +A software that records when you press a button down, and types what you said when you release it. + + +https://github.com/sloganking/desk-talk/assets/16965931/e5da605b-3a9d-4394-b4ec-a3de65605a65 + + +## Quickstart + +Assign your OpenAI API key to the `OPENAI_API_KEY` environment variable and run: + +``` +desk-talk --ptt-key scroll-lock +``` + +Or pass your OpenAI API key as a flag like so: + +``` +desk-talk --ptt-key scroll-lock --api-key [YOUR_API_KEY] +``` + +`desk-talk` will now record every time you hold down the ptt-key, and type what you spoke every time you release it. + +## Other Usage + +### Special Keys + +To find the name of a key by pressing it, run: + +``` +desk-talk show-key-presses +``` + +If your key shows as `Unknown(number)`, pass `number` to the `--special-ptt-key` flag like so: + +``` +desk-talk --special-ptt-key 125 +``` + +### Non-default recording device + +To use a microphone other than the system default, run + + +``` +desk-talk list-devices +``` + +to get a list of system microphone names. And pass the desired microphone name to ``--device`` like so: + + +``` +desk-talk --ptt-key scroll-lock --device "Microphone (3- USB Audio Device)" +``` + +