TastyPancakes/PkgTemplates.jl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs slightly

Browse Source
This commit is contained in:
Chris de Graaf 2017-08-21 14:52:50 -05:00
parent 32173feb9f
commit 3a2ce9ee46
3 changed files with 5 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -51,7 +51,7 @@ julia> t = Template(;
license="MIT",
authors=["Chris de Graaf", "Invenia Technical Computing Corporation"],
years="2016-2017",
dir=joinpath(ENV["HOME"], "code"),
dir=joinpath(homedir(), "code"),
julia_version=v"0.5.2",
requirements=["PkgTemplates"],
git_config=Dict("diff.renames" => true),
@ -60,7 +60,7 @@ julia> t = Template(;
CodeCov(; config_file=nothing),
Coveralls(),
AppVeyor(),
GitHubPages(; assets=[joinpath(ENV["HOME"], "invenia.css")]),
GitHubPages(; assets=[joinpath(homedir(), "invenia.css")]),
],
)

4
docs/src/index.md
View File

@ -37,7 +37,7 @@ t = Template(;
license="MIT",
authors=["Chris de Graaf", "Invenia Technical Computing Corporation"],
years="2016-2017",
dir=joinpath(ENV["HOME"], "code"),
dir=joinpath(homedir(), "code"),
julia_version=v"0.5.2",
requirements=["PkgTemplates"],
git_config=Dict("diff.renames" => true),
@ -46,7 +46,7 @@ t = Template(;
CodeCov(; config_file=nothing),
Coveralls(),
AppVeyor(),
GitHubPages(; assets=[joinpath(ENV["HOME"], "invenia.css")]),
GitHubPages(; assets=[joinpath(homedir(), "invenia.css")]),
],
)
generate("MyPkg", t; force=true, ssh=true)

6
src/generate.jl
View File

@ -6,11 +6,7 @@
ssh::Bool=false,
) -> Void
Generate a package from a template.
# Arguments
* `pkg_name::AbstractString`: Name of the package (with or without trailing ".jl").
* `t::Template`: The template from which to generate the package.
Generate a package names `pkg_name` from `template`.
# Keyword Arguments
* `force::Bool=false`: Whether or not to overwrite old packages with the same name.