Skip to content

Commit e4c8e0d

Browse files
Added readme and license
1 parent 1f35078 commit e4c8e0d

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

NOTICE

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright 2025 Soumalya Ghosh
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

readme.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Captr
2+
3+
**Captr** is a lightweight screen capturing and recording tool written in Go. It's designed for speed, simplicity, and minimal resource usage.
4+
(Windows OS Only)
5+
6+
> **Status:** Beta
7+
> Currently supports full-screen and window-specific screenshots. Recording functionality is in development.
8+
9+
## Features
10+
11+
- 📸 Capture full-screen screenshots
12+
- 🖼️ Capture specific window screenshots
13+
- 🎥 Screen recording (coming soon)
14+
15+
## Installation
16+
On first run, it auto creates an appdata directory `captr` and puts the config file inside. No separate installation required.
17+
18+
## Usage
19+
Download the exe from the releases or [build yourself]()<br>
20+
Run the exe to use it or pass the `--config` flag to open the config file.<br>
21+
For recording functionaility, you must have `ffmpeg` installed and added to path. If you don't have it, the app has the prebuilt prompt to download ffmpeg to the `%appdata%\captr\bin` folder in appdata to use.
22+
23+
## Roadmap
24+
- [x] Full-Screen Screenshots
25+
- [x] Window-Specific Screenshots
26+
- [ ] Screen Recording
27+
- [ ] Window Recording
28+
29+
## Build Yourself
30+
### Prerequisites
31+
- Golang (>=1.22)
32+
- Mingw-w64
33+
34+
Run `go build` to build the standalone exe file.
35+
36+
## Contributing
37+
Contributions are welcome. Open an issue or submit a pr.
38+
39+
## License
40+
Apache License, Version 2.0

0 commit comments

Comments
 (0)