diff --git a/README.md b/README.md index e9e45a3..f23dd43 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# Sandpoints git hook + this repo was initialized and `sphook` binary built like this: ``` go mod init main @@ -20,7 +22,7 @@ it should work for two scenarios: 1) in _bare_ git repository scenario it should work as a post-receive hook 2) in _working_ git repository scenario it should work as a post-commit hook -regarding scenarion `sphook` will be renamed into `.git/hooks/post-commit`, `gitea_repo.git/hooks/post-received.d/sphook` or whatever is prepared/set in `.git/hooks` directory to trigger an executable after the specific hook. +regarding scenario `sphook` will be renamed into `.git/hooks/post-commit`, `gitea_repo.git/hooks/post-received.d/sphook` or whatever is prepared/set in `.git/hooks` directory to trigger an executable after the specific hook. its task is simple: it takes content from `content/` directory and run `hugo` against it. it places the output into: @@ -33,4 +35,6 @@ it is good to check out the logs of git commit in order to find the path of that /var/www/html/sandpoints/{hugo_project_name}-{`crc32.ChecksumIEEE(git_repo_path)`}/last-commit-log.txt /var/www/html/sandpoints/{hugo_project_name}-{`crc32.ChecksumIEEE(git_repo_path)`}/_preview/last-commit-log.txt -``` \ No newline at end of file +``` + +`install_sphook.sh` bash script will install `sphook` in gitea as a `post-receive` hook. it will delete itself if `sphook` is already in `hooks/post-receive.d/` directory. \ No newline at end of file