tux/highminded
1
0
Fork 0
mirror of https://github.com/tuxdotrs/highminded.git synced 2025-08-23 08:01:03 +05:30
Code Issues Packages Projects Releases Wiki Activity

doc: update README.md

Browse Source
This commit is contained in:
tux
2025-07-04 20:14:25 +05:30
parent c8f13bd437
commit 8a299b0cf2
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -14,7 +14,9 @@
</div> </div>
<!-- TABLE OF CONTENTS --> <!-- TABLE OF CONTENTS -->
## Table of Contents ## Table of Contents
- [Features](#features) - [Features](#features)
- [Installation](#installation) - [Installation](#installation)
- [Keybindings](#keybindings) - [Keybindings](#keybindings)
@@ -22,31 +24,40 @@
- [License](#license) - [License](#license)
<!-- FEATURES --> <!-- FEATURES -->
## Features ## Features
- [x] Undectable Window - The application window remains hidden during screen sharing, ensuring complete discretion. - [x] Undectable 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] 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] 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] 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) - [ ] Custom Keybindings - Fully customizable keyboard shortcuts—tailor the tool to your workflow. (planned)
- [ ] Conversation - Get smarter replies with awareness of ongoing conversation context. (planned)
<!-- INSTALLATION --> <!-- INSTALLATION -->
## Installation ## Installation
Get the appropriate binary for your platform from the [release page](https://github.com/tuxdotrs/highminded/releases). Get the appropriate binary for your platform from the [release page](https://github.com/tuxdotrs/highminded/releases).
<!-- KEYBINDINGS --> <!-- KEYBINDINGS -->
## Keybindings ## Keybindings
| Bind | Action | | Bind | Action |
|--------------------------------|----------------------------------------------------------------------------------------------------------------| |--------------------------------|----------------------------------------------------------------------------------------------------------------|
| `Shift` + `\` | Toggle Window Visibility | | `Shift` + `\` | Toggle Window Visibility |
| `Shift` + `S` | Capture screenshot and send to LLM | | `Shift` + `S` | Capture screenshot and send to LLM |
| `Shift` + `A` | Capture audio and send to LLM |
| `Alt` + `Shift` + `Q` | Quit application | | `Alt` + `Shift` + `Q` | Quit application |
| `Ctrl` + `Alt` + `Shift` + `H` | Make windows visible to screenshare.<br> **Note: Application restart is required to make it invisible again.** | | `Ctrl` + `Alt` + `Shift` + `H` | Make windows visible to screenshare.<br> **Note: Application restart is required to make it invisible again.** |
<!-- CONTRIBUTING --> <!-- CONTRIBUTING -->
## 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".
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! Don't forget to give the project a star! Thanks again!
1. Fork the Project 1. Fork the Project
@@ -56,6 +67,7 @@ Don't forget to give the project a star! Thanks again!
5. Open a Pull Request 5. Open a Pull Request
<!-- LICENSE --> <!-- LICENSE -->
## License ## License
Distributed under the MIT License. See `LICENSE` for more information. Distributed under the MIT License. See `LICENSE` for more information.