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

Change order of file generation, add notes about PkgDev

Browse Source
This commit is contained in:
Chris de Graaf 2017-08-16 16:00:15 -05:00
parent 51c7f3459f
commit 4a9cf7629f
2 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -12,8 +12,9 @@ repeatable, and customizable way.**
## Installation
`PkgTemplates` is registered in
[`METADATA.jl`](https://github.com/JuliaLang/METADATA.jl), so just run
`Pkg.add("PkgTemplates")`.
[`METADATA.jl`](https://github.com/JuliaLang/METADATA.jl), so run
`Pkg.add("PkgTemplates")` for the latest release, or
`Pkg.clone("PkgTemplates")` for the development version.
## Usage
@ -28,7 +29,7 @@ julia> generate("MyPkg", t; force=true)
INFO: Initialized git repo at /tmp/tmpvaHVki/MyPkg
INFO: Made initial empty commit
INFO: Set remote origin to https://github.com/invenia/MyPkg.jl
INFO: Staged 5 files/directories: src/, REQUIRE, test/, README.md, .gitignore
INFO: Staged 5 files/directories: src/, test/, REQUIRE, .gitignore, README.md
INFO: Committed files generated by PkgTemplates
INFO: Copying temporary package directory into /home/degraafc/.julia/v0.6/
INFO: Finished
@ -69,7 +70,7 @@ INFO: Applying git configuration
INFO: Made initial empty commit
INFO: Set remote origin to git@github.com:invenia/MyPkg.jl.git
INFO: Created empty gh-pages branch
INFO: Staged 9 files/directories: LICENSE, src/, REQUIRE, test/, README.md, .gitignore, .travis.yml, .appveyor.yml, docs/
INFO: Staged 9 files/directories: src/, test/, REQUIRE, README.md, .gitignore, LICENSE, .travis.yml, .appveyor.yml, docs/
INFO: Committed files generated by PkgTemplates
INFO: Copying temporary package directory into /home/degraafc/code/
INFO: Finished
@ -78,3 +79,11 @@ WARNING: Remember to push all created branches to your remote: git push --all
Information on each keyword as well as plugin types can be found in the
[documentation](https://invenia.github.io/PkgTemplates.jl/stable).
## Comparison to [PkgDev](https://github.com/JuliaLang/PkgDev.jl)
`PkgTemplates` is similar in functionality to `PkgDev`'s `generate` function.
However, `PkgTemplates` offers more customizability in templates and more
extensibility via plugins. For the package registration and release management
features that `PkgTemplates` lacks, you are encouraged to use
[AttoBot](https://github.com/apps/attobot) instead.

4
src/generate.jl
View File

@ -57,12 +57,12 @@ function generate(
# Generate the files.
files = vcat(
gen_license(pkg_name, t),
gen_entrypoint(pkg_name, t),
gen_require(temp_pkg_dir, t),
gen_tests(pkg_name, t),
gen_require(temp_pkg_dir, t),
gen_readme(pkg_name, t),
gen_gitignore(pkg_name, t),
gen_license(pkg_name, t),
vcat(collect(gen_plugin(plugin, t, pkg_name) for plugin in values(t.plugins))...),
)