Update badge links and example username
This commit is contained in:
parent
3ff1fbcd73
commit
3d707ed0ac
18
README.md
18
README.md
@ -1,10 +1,10 @@
|
||||
# PkgTemplates
|
||||
|
||||
[](https://christopher-dG.github.io/PkgTemplates.jl/stable)
|
||||
[](https://christopher-dG.github.io/PkgTemplates.jl/latest)
|
||||
[](https://travis-ci.org/christopher-dG/PkgTemplates.jl)
|
||||
[](https://invenia.github.io/PkgTemplates.jl/stable)
|
||||
[](https://invenia.github.io/PkgTemplates.jl/latest)
|
||||
[](https://travis-ci.org/invenia/PkgTemplates.jl)
|
||||
[](https://ci.appveyor.com/project/christopher-dG/PkgTemplates-jl)
|
||||
[](https://codecov.io/gh/christopher-dG/PkgTemplates.jl)
|
||||
[](https://codecov.io/gh/invenia/PkgTemplates.jl)
|
||||
|
||||
**PkgTemplates is a Julia package for creating new Julia packages in an easy,
|
||||
repeatable, and customizable way.**
|
||||
@ -23,12 +23,12 @@ The simplest template only requires your GitHub username.
|
||||
```julia
|
||||
julia> using PkgTemplates
|
||||
|
||||
julia> t = Template(; user="christopher-dG")
|
||||
julia> t = Template(; user="myusername")
|
||||
|
||||
julia> generate("MyPkg", t)
|
||||
INFO: Initialized git repo at /tmp/tmpvaHVki/MyPkg
|
||||
INFO: Made initial empty commit
|
||||
INFO: Set remote origin to https://github.com/christopher-dG/MyPkg.jl
|
||||
INFO: Set remote origin to https://github.com/myusername/MyPkg.jl
|
||||
INFO: Staged 5 files/directories: src/, test/, REQUIRE, .gitignore, README.md
|
||||
INFO: Committed files generated by PkgTemplates
|
||||
INFO: Moving temporary package directory into /home/degraafc/.julia/v0.6/
|
||||
@ -47,7 +47,7 @@ However, we can also configure a number of keyword arguments to `Template` and
|
||||
|
||||
```julia
|
||||
julia> t = Template(;
|
||||
user="christopher-dG",
|
||||
user="myusername",
|
||||
license="MIT",
|
||||
authors=["Chris de Graaf", "Invenia Technical Computing Corporation"],
|
||||
years="2016-2017",
|
||||
@ -68,7 +68,7 @@ julia> generate("MyPkg", t; force=true, ssh=true)
|
||||
INFO: Initialized git repo at /tmp/tmpe0dWY5/MyPkg
|
||||
INFO: Applying git configuration
|
||||
INFO: Made initial empty commit
|
||||
INFO: Set remote origin to git@github.com:christopher-dG/MyPkg.jl.git
|
||||
INFO: Set remote origin to git@github.com:myusername/MyPkg.jl.git
|
||||
INFO: Created empty gh-pages branch
|
||||
INFO: Staged 9 files/directories: src/, test/, REQUIRE, README.md, .gitignore, LICENSE, .travis.yml, .appveyor.yml, docs/
|
||||
INFO: Committed files generated by PkgTemplates
|
||||
@ -91,7 +91,7 @@ test/runtests.jl
|
||||
```
|
||||
|
||||
Information on each keyword as well as plugin types can be found in the
|
||||
[documentation](https://christopher-dG.github.io/PkgTemplates.jl/stable).
|
||||
[documentation](https://invenia.github.io/PkgTemplates.jl/stable).
|
||||
|
||||
If that looks like a lot of work, you can also create templates interactively
|
||||
with `interactive_template`:
|
||||
|
@ -1,10 +1,10 @@
|
||||
# PkgTemplates
|
||||
|
||||
[](https://christopher-dG.github.io/PkgTemplates.jl/stable)
|
||||
[](https://christopher-dG.github.io/PkgTemplates.jl/latest)
|
||||
[](https://travis-ci.org/christopher-dG/PkgTemplates.jl)
|
||||
[](https://invenia.github.io/PkgTemplates.jl/stable)
|
||||
[](https://invenia.github.io/PkgTemplates.jl/latest)
|
||||
[](https://travis-ci.org/invenia/PkgTemplates.jl)
|
||||
[](https://ci.appveyor.com/project/christopher-dG/PkgTemplates-jl)
|
||||
[](https://codecov.io/gh/christopher-dG/PkgTemplates.jl)
|
||||
[](https://codecov.io/gh/invenia/PkgTemplates.jl)
|
||||
|
||||
**PkgTemplates is a Julia package for creating new Julia packages in an easy,
|
||||
repeatable, and customizable way.**
|
||||
@ -22,7 +22,7 @@ The simplest template only requires your GitHub username.
|
||||
|
||||
```@repl
|
||||
using PkgTemplates
|
||||
t = Template(; user="christopher-dG")
|
||||
t = Template(; user="myusername")
|
||||
generate("MyPkg", t)
|
||||
cd(joinpath(t.dir, "MyPkg")); run(`git ls-tree -r --name-only HEAD`)
|
||||
```
|
||||
@ -33,7 +33,7 @@ However, we can also configure a number of keyword arguments to
|
||||
```@repl
|
||||
using PkgTemplates
|
||||
t = Template(;
|
||||
user="christopher-dG",
|
||||
user="myusername",
|
||||
license="MIT",
|
||||
authors=["Chris de Graaf", "Invenia Technical Computing Corporation"],
|
||||
years="2016-2017",
|
||||
|
Loading…
Reference in New Issue
Block a user