Skip to content

Commit 5cfe69c

Browse files
綾人綾人
authored andcommitted
Merge branch 'feature/add-readme' into develop
2 parents 34c65c0 + 1c45bb4 commit 5cfe69c

4 files changed

Lines changed: 26 additions & 1 deletion

File tree

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,9 @@ go.work.sum
2323

2424
# env file
2525
.env
26+
27+
# Build output
28+
snapcode
29+
30+
# Generated screenshots
31+
generated_code.png

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
# SnapCode
1+
# SnapCode
2+
3+
SnapCode is a simple CLI tool that converts code snippets into stylish screenshots automatically.
4+
5+
## Features
6+
7+
- Input a code snippet via command line
8+
- Generate a beautiful screenshot from the code
9+
- Supports dark theme (default)
10+
11+
## Getting Started
12+
13+
### Build
14+
15+
```bash
16+
git clone git@github.com:uruya/SnapCode.git
17+
cd SnapCode
18+
go build -o snapcode ./cmd/cli
19+
./snapcode 'console.log("Hello, SnapCode!");'
20+
```

cmd/cli/generated_code.png

-2.25 KB
Binary file not shown.

cmd/cli/snapcode

-14.2 MB
Binary file not shown.

0 commit comments

Comments
 (0)