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.

Sign up for GitHub

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

docs: Add comments in helper.sh #36

Merged
merged 1 commit into from
Nov 27, 2020
Merged

docs: Add comments in helper.sh #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 16 additions & 1 deletion helper.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@
# -*- compile-command: "./helper.sh gen"; -*-
# Author: Erik Martin-Dorel, 2020

## Usage
#
# Run (./helper.sh --help)
#
## Overview
#
# Run (./helper.sh gen) to generate min.sh;
# Copy-and-paste min.sh in entrypoint.sh.
#
## Remark
#
# The generated code in min.sh is escaped as needed by entrypoint.sh.
# Replace escape="true" with escape="false" in minimify() if you want
# to test the code locally after doing (./helper.sh gen && . min.sh).

srcdir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )

# shellcheck source=./timegroup.sh
Expand Down Expand Up @@ -50,7 +65,7 @@ main_helper () {
echo -n ' ; '
minimify startGroup
echo ' # generated from helper.sh'
elif [ $# -eq 1 ] && [ "$1" = "--help" ]; then
else
cat <<EOF
Usage:

Expand Down