Files
highminded/README.md
Luke Berry 5c6227127d Update README.md
fix: README typo
2025-07-07 11:34:11 +01:00

76 lines
2.8 KiB
Markdown

<div align="center">
<h3 align="center">High Minded</h3>
<p align="center">
Your undetectable personal assistance
</p>
<p align="center">
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/tuxdotrs/highminded">
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/tuxdotrs/highminded">
</p>
</div>
<div align="center">
<img alt="highminded-screenshot" src="https://github.com/user-attachments/assets/eca4624f-9194-4c02-8e72-b42979c23cb5" />
</div>
<!-- TABLE OF CONTENTS -->
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Keybindings](#keybindings)
- [Contributing](#contributing)
- [License](#license)
<!-- FEATURES -->
## Features
- [x] undetectable Window - The application window remains hidden during screen sharing, ensuring complete discretion.
- [x] Screen Capture - Capture your screen and receive relevant insights or assistance based on the content.
- [x] BYO Model - Bring your own LLM—works with any model supporting the OpenAI-compatible API.
- [x] Custom Prompt - Define your own prompt to guide the assistant according to your specific needs.
- [x] Conversation - Get smarter replies with awareness of ongoing conversation context. (MacOS planned)
- [ ] Custom Keybindings - Fully customizable keyboard shortcuts—tailor the tool to your workflow. (planned)
<!-- INSTALLATION -->
## Installation
Get the appropriate binary for your platform from
the [release page](https://github.com/tuxdotrs/highminded/releases).<br>
On the first launch make sure to provide relevant information in the settings tab.
<!-- KEYBINDINGS -->
## Keybindings
| Bind | Action |
|--------------------------------|-----------------------------------------|
| `Alt` + `Shift` + `\` | Toggle window visibility |
| `Alt` + `Shift` + `S` | Capture screenshot and send to LLM |
| `Alt` + `Shift` + `A` | Capture audio and send to LLM |
| `Alt` + `Shift` + `Q` | Quit application |
| `Ctrl` + `Alt` + `Shift` + `H` | Toggle window visibility on Screenshare |
<!-- CONTRIBUTING -->
## Contributing
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also
simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<!-- LICENSE -->
## License
Distributed under the GPL-3.0 License. See `LICENSE` for more information.