PkgTemplates.jl/README.md

1.3 KiB

PkgTemplates

Stable Dev Build Status Codecov

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

Usage

Assuming you have the relatively standard Git options user.name, user.email and github.user set up globally with git config --global, creating a Template is as simple as:

using PkgTemplates
t = Template()

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

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

Once you have a Template, yoy can createa packages with ease:

t("MyPkg")

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