PkgTemplates.jl/README.md

PkgTemplates

PkgTemplates creates new Julia packages in an easy, repeatable, and customizable way.

Installation

Install with Pkg, just like any other registered Julia package:

pkg> add PkgTemplates  # Press ']' to enter the Pkg REPL mode.

Usage

Creating a Template is as simple as:

using PkgTemplates
t = Template()

The no-keywords constructor assumes the existence of some preexisting Git configuration (set with git config --global):

• user.name: Your real name, e.g. John Smith.
• user.email: Your email address, eg. john.smith@acme.corp.
• github.user: Your GitHub username: e.g. john-smith.

Once you have a Template, use it to generate a package:

t("MyPkg")

However, it's probably desirable to customize the template to your liking with various options and plugins:

t = Template(;
    dir="~/code",
    plugins=[
        Git(; manifest=true, ssh=true),
        Codecov(),
        TravisCI(; x86=true),
        Documenter{TravisCI}(),
    ],
)

---

For a much more detailled overview, please see the documentation.

Contributing

Issues and pull requests are welcome! For some more specific tips, see the developer documentation.