Skip to content

Commit

Permalink
#1308: add docs about deps licenses
Browse files Browse the repository at this point in the history
  • Loading branch information
Badgerati committed May 27, 2024
1 parent fddecd1 commit 1b4ac4a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/Getting-Started/Licenses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Licenses

Pode's core license is MIT, which can be [found here](https://github.com/Badgerati/Pode/blob/develop/LICENSE.txt).

Pode also has several dependencies, some of which are optional and some of which are mandatory - depending on the feature you're using within Pode. For example, if you're using OpenAPI and render the documentation via Swagger or ReDoc then these are mandatory dependencies. However, if you're returning YAML data from a Route then you can either use Pode's inbuilt YAML converter, or you can optionally use [PSYAML](https://github.com/Phil-Factor/PSYaml) or [powershell-yaml](https://github.com/cloudbase/powershell-yaml) and Pode will detect these are installed.

The licenses for Pode dependencies, whether they're optional or mandatory, can be [found here](https://github.com/Badgerati/Pode/tree/develop/licenses), and they are also released alongside Pode's module within a `/licenses` folder.
2 changes: 1 addition & 1 deletion pode.build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ Task PushCodeCoverage -If (Test-PodeBuildCanCodeCoverage) {

# Synopsis: Run the documentation locally
Task Docs DocsDeps, DocsHelpBuild, {
mkdocs serve
mkdocs serve --open
}

# Synopsis: Build the function help documentation
Expand Down

0 comments on commit 1b4ac4a

Please sign in to comment.