Skip to content

Commit 4d8c639

Browse files
committed
docs: enhance README and add MIT license
1 parent 4e30c26 commit 4d8c639

File tree

2 files changed

+69
-14
lines changed

2 files changed

+69
-14
lines changed

WindPixMVP/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) 2024 WindPix Contributors
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.

WindPixMVP/README.md

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,23 @@ A command-line tool that automates the process of taking and sharing screenshots
1515
- Xcode 13.0 or later
1616
- Swift 5.9 or later
1717

18-
## Building
18+
## Installation
1919

20-
To build the project, run:
20+
1. Clone the repository:
21+
```bash
22+
git clone https://github.com/bartwisch/windpix.git
23+
cd windpix/WindPixMVP
24+
```
2125

22-
```bash
23-
swift build
24-
```
26+
2. Build the project:
27+
```bash
28+
swift build
29+
```
2530

26-
## Running
27-
28-
To run the built executable:
29-
30-
```bash
31-
.build/debug/WindPixMVP
32-
```
31+
3. Run the app:
32+
```bash
33+
.build/debug/WindPixMVP
34+
```
3335

3436
## Permissions Required
3537

@@ -39,6 +41,15 @@ The app requires the following permissions:
3941
- Accessibility (for simulating keyboard events)
4042
- Input Monitoring (for global hotkey)
4143

44+
### Setting up Permissions
45+
46+
1. Open System Preferences > Security & Privacy > Privacy
47+
2. Enable permissions for:
48+
- Screen Recording
49+
- Accessibility
50+
- Input Monitoring
51+
3. Restart the app after granting permissions
52+
4253
## Development Status
4354

4455
This is an MVP (Minimum Viable Product) version that implements the basic functionality of capturing and sharing screenshots. Future versions will include:
@@ -49,5 +60,28 @@ This is an MVP (Minimum Viable Product) version that implements the basic functi
4960
- Error handling
5061
- Installer
5162
- Auto-updates
52-
- Multiple monitor support
53-
- Custom screenshot area
63+
64+
## Contributing
65+
66+
We welcome contributions! Here's how you can help:
67+
68+
1. Fork the repository
69+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
70+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
71+
4. Push to the branch (`git push origin feature/amazing-feature`)
72+
5. Open a Pull Request
73+
74+
Please make sure to update tests as appropriate and follow the existing coding style.
75+
76+
## Bug Reports & Feature Requests
77+
78+
If you encounter any bugs or have ideas for new features, please [open an issue](https://github.com/bartwisch/windpix/issues).
79+
80+
## License
81+
82+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
83+
84+
## Acknowledgments
85+
86+
- Thanks to the Windsurf team for inspiration and support
87+
- All contributors who help improve this project

0 commit comments

Comments
 (0)