3 lines
5.2 KiB
HTML
3 lines
5.2 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Licenses · PkgTemplates.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><a class="toctext" href="package_generation.html">Package Generation</a></li><li><a class="toctext" href="plugins.html">Plugins</a></li><li><a class="toctext" href="plugin_development.html">Plugin Development</a></li><li class="current"><a class="toctext" href="licenses.html">Licenses</a><ul class="internal"><li><a class="toctext" href="#available_licenses-1"><code>available_licenses</code></a></li><li><a class="toctext" href="#show_license-1"><code>show_license</code></a></li><li><a class="toctext" href="#Helper-Functions-1">Helper Functions</a></li></ul></li><li><a class="toctext" href="index.html">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="licenses.html">Licenses</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/docs/src/pages/licenses.md#L{line}"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Licenses</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Licenses-1" href="#Licenses-1">Licenses</a></h1><p><a href="https://github.com/christopher-dG/PkgTemplates.jl/tree/master/licenses">Many open-source licenses</a> are available for use with <code>PkgTemplates</code>, but if you see that one is missing, don't hesitate to open an issue or PR.</p><h2><a class="nav-anchor" id="available_licenses-1" href="#available_licenses-1"><code>available_licenses</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.available_licenses" href="#PkgTemplates.available_licenses"><code>PkgTemplates.available_licenses</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">available_licenses([io::IO]) -> Void</code></pre><p>Print the names of all available licenses.</p></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/licenses.jl#LL14-L18">source</a><br/></section><h2><a class="nav-anchor" id="show_license-1" href="#show_license-1"><code>show_license</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.show_license" href="#PkgTemplates.show_license"><code>PkgTemplates.show_license</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">show_license([io::IO], license::AbstractString) -> Void</code></pre><p>Print the text of <code>license</code>.</p></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/licenses.jl#LL22-L26">source</a><br/></section><h2><a class="nav-anchor" id="Helper-Functions-1" href="#Helper-Functions-1">Helper Functions</a></h2><h4><a class="nav-anchor" id="read_license-1" href="#read_license-1"><code>read_license</code></a></h4><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.read_license" href="#PkgTemplates.read_license"><code>PkgTemplates.read_license</code></a> — <span class="docstring-category">Function</span>.</div><div><pre><code class="language-none">read_license(license::AbstractString) -> String</code></pre><p>Returns the contents of <code>license</code>. Errors if it is not found. Use <a href="licenses.html#PkgTemplates.available_licenses"><code>available_licenses</code></a> to view available licenses.</p></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/licenses.jl#LL30-L35">source</a><br/></section><footer><hr/><a class="previous" href="plugin_development.html"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="index.html"><span class="direction">Next</span><span class="title">Index</span></a></footer></article></body></html>
|