Skip to content

SB:Added explanation for boilerplate code #3

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

SB:Added explanation for boilerplate code #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d1569f
SB: edited tutorial to explain boilerplate code
Feb 12, 2015
7f70376
SB: minor change in readme
Feb 12, 2015
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ _program()
}
}

# boilerplate code -- > starts here

_program_name='overdrive'
_program_version='unversioned'
_program_package_or_build=''
Expand All @@ -84,11 +86,15 @@ _program_etcPath="${_program_path}/etc"
_program_varPath="${_program_path}/var"
_program_entrypoint='overdrive'

# < -- ends here

# Assumes pwd, and so requires this code to be running from this folder
. "$_program_libPath"/shellfire/core/init.functions "$@"
```

Boilerplate code will enable program to load libraries and other dependency code , which makes this script standalone


Now run it with `./overdrive` - you should see `Hello World`. Try `./overdrive --help` and `./overdrive --version`. Of course, this isn't a very useful program. Let's at least give it a purpose.

## Parsing the command line
Expand Down