Add README checker

This commit is contained in:
femsci 2022-11-05 01:11:03 +01:00
parent 68c2515b5a
commit 7f4c294758
Signed by: femsci
GPG key ID: 08F7911F0E650C67

View file

@ -0,0 +1,21 @@
#!/usr/bin/env bash
description() {
echo "Checks for README.md file with the proper extension."
}
config() {
echo "README_BYPASS_EXT:bypasses extension check"
echo "README_BYPASS_ENO:bypasses execution halt when the README file is missing"
}
if [[ -e README ]]; then
pinfo "README file found instead of README.md. Consider changing the extension..."
[[ -z $README_BYPASS_EXT ]] && exit 1
else
if [[ -e README.md ]]; then
pinfo "README.md file found."
else
pwarn "No README file found..."
[[ -z $README_BYPASS_ENO ]] && exit 2
fi
fi