Skip to content

Commit f022785

Browse files
committed
Added internal documentation per h5bp#813
1 parent 8d50ceb commit f022785

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

build/createproject.sh

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,25 @@
66

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

1111
##usage
1212
# $ cd html5-boilerplate/build
13-
# $ ./createproject.sh
13+
# $ ./createproject.sh [new_project]
14+
15+
#
16+
# If [new_project] is not specified the user we will prompted to enter it.
17+
#
18+
# The format of [new_project] should ideally be lowercase letters with no
19+
# spaces as it represents the directory name that your new project will live
20+
# in.
21+
#
22+
# If the new project is specified as just a name ( "foo" ) then the path
23+
# will be a sibling to html5-boilerplate's directory.
24+
#
25+
# If the new project is specified with an absolute path ( "/home/user/foo" )
26+
# that path will be used.
27+
#
1428

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

0 commit comments

Comments
 (0)