From c491e7a4dd884ae28a3cc7a1f1b010f8aa67f9c3 Mon Sep 17 00:00:00 2001 From: Morten Piibeleht Date: Thu, 14 Feb 2019 16:07:32 +1300 Subject: [PATCH 1/3] Clarify Usage section in docs --- docs/src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/index.md b/docs/src/index.md index 16484dd..7384b85 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -28,7 +28,7 @@ Pkg.activate(mktempdir()) Pkg.add(PackageSpec(path=dirname(dirname(pwd())))) ``` -The simplest template requires no arguments. +The simplest template, assuming that you have set up the `github.user` Git option globally with `git config`, requires no arguments. ```@repl usage From 9a6feac95b60fffd5db78e1546ea9c3fad271315 Mon Sep 17 00:00:00 2001 From: Morten Piibeleht Date: Thu, 14 Feb 2019 16:13:16 +1300 Subject: [PATCH 2/3] Mention other options too --- docs/src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/index.md b/docs/src/index.md index 7384b85..6935a8c 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -28,7 +28,7 @@ Pkg.activate(mktempdir()) Pkg.add(PackageSpec(path=dirname(dirname(pwd())))) ``` -The simplest template, assuming that you have set up the `github.user` Git option globally with `git config`, requires no arguments. +Assuming you have the relatively standard Git options `user.name`, `user.email` and `github.user` set up globally with `git config --global`, the simplest template requires no arguments: ```@repl usage From 0f7c651f03558a30dc0e53b07a0d04d9de7821b5 Mon Sep 17 00:00:00 2001 From: Morten Piibeleht Date: Thu, 14 Feb 2019 21:31:00 +1300 Subject: [PATCH 3/3] Update the README too --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 833364a..0fe86b8 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ pkg> add PkgTemplates ## Usage -The simplest template requires no arguments. +Assuming you have the relatively standard Git options `user.name`, `user.email` and `github.user` set up globally with `git config --global`, the simplest template requires no arguments: ```julia julia> using PkgTemplates