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 te 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}(),
o    ],
)

You can also create a Template interactively by following a set of prompts:

julia> t = Template(; interactive=true)

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

1.7 KiB Raw Blame History

PkgTemplates

Installation

Usage

1.7 KiB

Raw Blame History