Skip to content

Commit 8013216

Browse files
committed
feature(readme): update readme
1 parent d533679 commit 8013216

File tree

2 files changed

+36
-4
lines changed

2 files changed

+36
-4
lines changed

Makefile

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Define variables for easy configuration
22
GO=go
33
BINARY_NAME=hyprhaven
4-
LDFLAGS=-s -w
4+
LDFLAGS=-s -w
55

66
# Default target, will build the binary
77
all: build
@@ -36,11 +36,14 @@ doc:
3636

3737
# Cross-compile for different platforms (Linux/Windows/macOS)
3838
build-linux:
39-
GOOS=linux GOARCH=amd64 $(GO) build -o $(BINARY_NAME) .
39+
GOOS=linux GOARCH=amd64 $(GO) build -ldflags "$(LDFLAGS)" -o $(BINARY_NAME) .
40+
41+
build-windows-debug:
42+
GOOS=windows GOARCH=amd64 $(GO) build -ldflags "$(LDFLAGS)" -o $(BINARY_NAME).exe .
4043

4144
build-windows:
42-
GOOS=windows GOARCH=amd64 $(GO) build -o $(BINARY_NAME).exe .
45+
GOOS=windows GOARCH=amd64 $(GO) build -ldflags "$(LDFLAGS) -H windowsgui" -o $(BINARY_NAME).exe .
4346

4447
build-darwin:
45-
GOOS=darwin GOARCH=amd64 $(GO) build -o $(BINARY_NAME) .
48+
GOOS=darwin GOARCH=amd64 $(GO) build -ldflags "$(LDFLAGS)" -o $(BINARY_NAME) .
4649

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<h1 align="center">Hyprhaven</h1>
2+
3+
<p align="center">Tired of your own wallpaper collection? Hyprhaven has you covered</p>
4+
5+
## About
6+
7+
This script fetches wallpapers from [wallhaven.cc](https://wallhaven.cc/) and sets it as desktop image
8+
9+
## Install
10+
11+
### Windows
12+
13+
TBD
14+
15+
## Build
16+
17+
1. Run makefile
18+
19+
`make`
20+
21+
## Configuration
22+
23+
TBD
24+
25+
## API key
26+
27+
API key is not required, if you don't plan on using your [wallhaven.cc](https://wallhaven.cc/) presets or NSFW search
28+
29+
TBD

0 commit comments

Comments
 (0)