Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KISS build docs #102

Open
wants to merge 3 commits into
base: freeze-feat-andreas
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Build
run: |
Expand All @@ -23,7 +23,7 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Check formatting
run: |
Expand All @@ -37,7 +37,11 @@ jobs:
uses: actions/checkout@v2

- name: Check docs
env:
DEBIAN_FRONTEND: noninteractive
run: |
sudo apt update
sudo apt install --no-install-recommends scdoc
for file in $(find . -type f -iwholename "./docs/*.scd"); do scdoc < $file > /dev/null; done
for file in ./docs/*.scd; do
scdoc < "$file" > /dev/null;
done
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
target
*.gz
*.out
.direnv
*.jpg
*.jpeg
Expand Down
1 change: 0 additions & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 17 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,24 @@ build:
run:
@cargo run

install: build
@mkdir -p $(TARGET_DIR)
@cp $(SOURCE_DIR)/$(BINARY) $(TARGET_DIR)
docs:
@echo -n 'Generating docs with scdoc and gzip ... '
@for file in ./docs/*.scd ; do \
scdoc < "$$file" | gzip --best > "$${file%.scd}.gz" ; \
done
@echo 'done!'

install: build docs
@mkdir -pv $(TARGET_DIR)
@cp -v $(SOURCE_DIR)/$(BINARY) $(TARGET_DIR)
@chmod +x $(TARGET_DIR)/$(BINARY)
@find ./docs -type f -iname "*.1.gz" -exec cp {} $(MAN1_DIR) \;
@find ./docs -type f -iname "*.7.gz" -exec cp {} $(MAN7_DIR) \;
@cp -v ./docs/wayshot.1.gz $(MAN1_DIR)
@cp -v ./docs/wayshot.7.gz $(MAN7_DIR)


uninstall:
@rm -f $(TARGET_DIR)/$(BINARY)
@rm -f /usr/share/man/**/wayshot.*
@rm -fv $(TARGET_DIR)/$(BINARY)
@rm -fv /usr/share/man/**/wayshot.*

check:
@cargo fmt
Expand All @@ -31,10 +39,10 @@ check:

clean:
@cargo clean
@rm -f ./docs/*.1.gz
@rm -fv ./docs/*.gz

setup:
@rustup install stable
@rustup default stable

.PHONY: check clean setup all install build
.PHONY: check clean setup all install build docs
5 changes: 0 additions & 5 deletions wayshot/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ keywords.workspace = true
license.workspace = true
repository.workspace = true

[build-dependencies]
flate2 = "1.0.27"
eyre = "0.6.8"


[dependencies]
tracing.workspace = true

Expand Down
81 changes: 0 additions & 81 deletions wayshot/build.rs

This file was deleted.

1 change: 0 additions & 1 deletion wayshot/docs

This file was deleted.

Loading