Skip to content

m1ka05/PkgTemplates.jl

This branch is 4 commits ahead of, 250 commits behind JuliaCI/PkgTemplates.jl:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

78379f6 · Jun 25, 2020
Apr 17, 2020
May 25, 2020
Jun 25, 2020
Jun 3, 2020
Jun 17, 2020
Sep 25, 2019
May 25, 2020
May 25, 2020
May 28, 2020
Jun 17, 2020
May 25, 2020

Repository files navigation

PkgTemplates

Stable Dev Build Status Codecov Code Style: Blue

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.

About

Create new Julia packages, the easy way

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Julia 99.8%
  • TeX 0.2%