Skip to content

Commit

Permalink
Added internal documentation per h5bp#813
Browse files Browse the repository at this point in the history
  • Loading branch information
simensen committed Oct 19, 2011
1 parent 8d50ceb commit f022785
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions build/createproject.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,25 @@

##first run
# $ cd html5-boilerplate/build
# $ chmod +x createproject.sh && ./createproject.sh
# $ chmod +x createproject.sh && ./createproject.sh [new_project]

##usage
# $ cd html5-boilerplate/build
# $ ./createproject.sh
# $ ./createproject.sh [new_project]

#
# If [new_project] is not specified the user we will prompted to enter it.
#
# The format of [new_project] should ideally be lowercase letters with no
# spaces as it represents the directory name that your new project will live
# in.
#
# If the new project is specified as just a name ( "foo" ) then the path
# will be a sibling to html5-boilerplate's directory.
#
# If the new project is specified with an absolute path ( "/home/user/foo" )
# that path will be used.
#

# find project root (also ensure script is ran from within repo)
src=$(git rev-parse --show-toplevel) || {
Expand Down

0 comments on commit f022785

Please sign in to comment.