Documentationgood-first-issuehelp wanted
Description
Hi. I'm just trying out PkgTemplates.jl in an attempt to master some of the more advanced package features - but ran into some difficulties.
New user's perspective
On my first attempt at using PkgTemplates.jl, I followed the instructions @ https://invenia.github.io/PkgTemplates.jl/stable/user/:
julia> using PkgTemplates
julia> t=Template()
ERROR: Git: Git hosting service username is required, set one with keyword `user="<username>"`
I was very surprised to see an error message so early on.
New user's perspective
I am mostly familiar with Git, but I did not understand this message.
- I thought this meant I did not setup my (global)
user.nameand/oruser.emailsettings in my.gitconfig- but this appears to be something else. - After a bit of searching around, I found the
helponTemplatementioned thegithub.usersetting. Before that instant, I was unaware that.gitconfigcould store github-specific parameters. - In retrospect, I can see that the error message was hinting I could specify the user parameter in my call to
Template()- but in my mind, it sounded like I needed to add something to my.gitconfigdirectly.
I get that PkgTemplates.jl is meant to simplify the configuration of Julia's more advanced package features. As such, it might well be targeting more advanced users. Nonetheless, I sort of feel like some background might be missing from the User Guide.