TastyPancakes/PkgTemplates.jl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add docs

Browse Source
This commit is contained in:
Chris de Graaf 2017-08-22 15:13:25 -05:00
parent 53b886ad6a
commit f8584a640e
4 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -93,10 +93,15 @@ test/runtests.jl
Information on each keyword as well as plugin types can be found in the Information on each keyword as well as plugin types can be found in the
[documentation](https://christopher-dG.github.io/PkgTemplates.jl/stable). [documentation](https://christopher-dG.github.io/PkgTemplates.jl/stable).
If that looks like a lot of work, you can also create templates interactively: If that looks like a lot of work, you can also create templates interactively
with `interactive_template`:
[![asciicast](https://asciinema.org/a/bqBwff05mI7Cl9bz7EqLPMKF8.png)](https://asciinema.org/a/bqBwff05mI7Cl9bz7EqLPMKF8) [![asciicast](https://asciinema.org/a/bqBwff05mI7Cl9bz7EqLPMKF8.png)](https://asciinema.org/a/bqBwff05mI7Cl9bz7EqLPMKF8)
And if that's **still** too much work for you, you can call
`interactive_template` with `fast=true` to use default values for everything
but username and plugin selection.
## Comparison to [PkgDev](https://github.com/JuliaLang/PkgDev.jl) ## Comparison to [PkgDev](https://github.com/JuliaLang/PkgDev.jl)
`PkgTemplates` is similar in functionality to `PkgDev`'s `generate` function. `PkgTemplates` is similar in functionality to `PkgDev`'s `generate` function.

11
docs/src/index.md
View File

@ -27,8 +27,8 @@ generate("MyPkg", t)
cd(joinpath(t.dir, "MyPkg")); run(`git ls-tree -r --name-only HEAD`) cd(joinpath(t.dir, "MyPkg")); run(`git ls-tree -r --name-only HEAD`)
``` ```
However, we can also configure a number of keyword arguments to [`Template`](@ref) and However, we can also configure a number of keyword arguments to
[`generate`](@ref): [`Template`](@ref) and [`generate`](@ref):
```@repl ```@repl
using PkgTemplates using PkgTemplates
@ -53,10 +53,15 @@ generate("MyPkg", t; force=true, ssh=true)
cd(joinpath(t.dir, "MyPkg")); run(`git ls-tree -r --name-only HEAD`) cd(joinpath(t.dir, "MyPkg")); run(`git ls-tree -r --name-only HEAD`)
``` ```
If that looks like a lot of work, you can also create templates interactively: If that looks like a lot of work, you can also create templates interactively
with [`interactive_template`](@ref):
[![asciicast](https://asciinema.org/a/bqBwff05mI7Cl9bz7EqLPMKF8.png)](https://asciinema.org/a/bqBwff05mI7Cl9bz7EqLPMKF8) [![asciicast](https://asciinema.org/a/bqBwff05mI7Cl9bz7EqLPMKF8.png)](https://asciinema.org/a/bqBwff05mI7Cl9bz7EqLPMKF8)
And if that's **still** too much work for you, you can call
`interactive_template` with `fast=true` to use default values for everything
but username and plugin selection.
## Comparison to [PkgDev](https://github.com/JuliaLang/PkgDev.jl) ## Comparison to [PkgDev](https://github.com/JuliaLang/PkgDev.jl)
`PkgTemplates` is similar in functionality to `PkgDev`'s `generate` function. `PkgTemplates` is similar in functionality to `PkgDev`'s `generate` function.

8
docs/src/pages/plugin_development.md
View File

@ -7,7 +7,8 @@ CurrentModule = PkgTemplates
The best and easiest way to contribute to `PkgTemplates` is to write new The best and easiest way to contribute to `PkgTemplates` is to write new
plugins. plugins.
There are two types of plugins: [`GenericPlugin`](@ref)s and [`CustomPlugin`](@ref)s. There are two types of plugins: [`GenericPlugin`](@ref)s and
[`CustomPlugin`](@ref)s.
## Generic Plugins ## Generic Plugins
@ -30,8 +31,9 @@ gen_plugin
interactive interactive
``` ```
**Note**: [`interactive`](@ref) is not strictly required, however without it, your custom **Note**: [`interactive`](@ref) is not strictly required, however without it,
plugin will not be available when creating templates with [`interactive_template`](@ref). your custom plugin will not be available when creating templates with
[`interactive_template`](@ref).
#### `badges` #### `badges`

6
docs/src/pages/plugins.md
View File

@ -4,9 +4,9 @@ CurrentModule = PkgTemplates
# Plugins # Plugins
Plugins are the driver for `PkgTemplates`'s customization and extension. This page Plugins are the driver for `PkgTemplates`'s customization and extension. This
describes plugins that already exist; for information on writing your own plugins, see page describes plugins that already exist; for information on writing your
[Plugin Development](@ref). own plugins, see [Plugin Development](@ref).
## `TravisCI` ## `TravisCI`