Skip to content

Commit 35f697d

Browse files
committed
docs: add README and MIT license
- add comprehensive README with installation instructions - include development setup and mise task documentation - specify system requirements and permission needs - add MIT license for open source distribution
1 parent 88e7564 commit 35f697d

File tree

2 files changed

+83
-0
lines changed

2 files changed

+83
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 mfyuu
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# PressViz
2+
3+
A native macOS app for visualizing keyboard presses.
4+
5+
## Installation
6+
7+
1. Download the latest DMG from [Releases](https://github.com/mfyuu/press-viz/releases)
8+
2. Open the DMG file
9+
3. Drag PressViz to your Applications folder
10+
4. Launch PressViz from Applications
11+
12+
### Requirements
13+
14+
- macOS 26.2+
15+
16+
### Permissions
17+
18+
PressViz requires **Accessibility** permission to monitor keyboard input.
19+
20+
1. Open System Settings > Privacy & Security > Accessibility
21+
2. Enable PressViz
22+
23+
## Development
24+
25+
### Prerequisites
26+
27+
- Xcode
28+
- [mise](https://mise.jdx.dev/) (optional, for task runner)
29+
- [create-dmg](https://github.com/create-dmg/create-dmg) (for DMG creation)
30+
31+
### Build
32+
33+
```bash
34+
# Debug build
35+
mise run build
36+
37+
# Release build
38+
mise run release
39+
40+
# Clean
41+
mise run clean
42+
```
43+
44+
### Version Management
45+
46+
```bash
47+
# Show current version
48+
mise run version
49+
50+
# Set version
51+
mise run version:set 0.2.0
52+
```
53+
54+
### Create DMG
55+
56+
```bash
57+
mise run dmg
58+
```
59+
60+
## License
61+
62+
MIT

0 commit comments

Comments
 (0)