Create new Julia packages, the easy way
Go to file
Chris de Graaf 18c32a1519
Interactive mode (#145)
2020-05-25 15:20:27 -05:00
.github/workflows Default to running TagBot daily (#154) 2020-04-17 15:45:06 -05:00
docs Interactive mode (#145) 2020-05-25 15:20:27 -05:00
src Interactive mode (#145) 2020-05-25 15:20:27 -05:00
templates Remove setup-julia from CompatHelper workflow 2020-03-19 08:20:10 +07:00
test Interactive mode (#145) 2020-05-25 15:20:27 -05:00
.gitattributes More tests, more Windows fiddling 2019-09-26 00:32:04 +07:00
.gitignore Interactive mode (#145) 2020-05-25 15:20:27 -05:00
.travis.yml Interactive mode (#145) 2020-05-25 15:20:27 -05:00
LICENSE Check and warn for unused keywords, update some metadata 2019-10-06 16:16:31 +07:00
Project.toml Interactive mode (#145) 2020-05-25 15:20:27 -05:00
README.md Add some testing docs 2020-04-17 23:48:33 -05:00

README.md

NOTICE: This version is not yet released

The current stable release is 0.6, you can find that version here.
PkgTemplates has undergone large internal changes (see #61 especially), and at present the user-facing API is still catching up.
Do not fear, while right now it looks very different (e.g. in the dev docs), it will not be incredibly breaking. But right now if you do use master it will be.


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.