readme.md

PeachPie Templates

This repository contains various dotnet project templates to be used for creating PeachPie compiled applications.

Using templates

0. Install peachpie templates via: dotnet new -i "Peachpie.Templates::*"
1. Create a project based on chosen template e.g.: dotnet new console -lang PHP
2. Restore packages for the newly created project: dotnet restore
3. Run the project: dotnet run

You need to install PeachPie templates only once. They get stored in ~HOME/.templateengine cache.

Prerequisites

• .NET Core SDK 2.1
• PowerShell (only for building)

Contributing templates & building

Adding a new template:

• Go to ./src/Content
• Create a new folder with name mathing the template's shortName
• Fill the folder with all that is required for a template
  • Official documentation on template creation
  • Tutorial on MSDN
  • Short introduction on rehansaeed.com
  • What is required for a PeachPie project

Building & testing

• Invoke .\build.ps1 which calls a build (1) and a test (2) script
  • 1: Packages all templates into a nuget package (see /out/Peachpie.Templates.x.y.z.nupkg)
  • 2: Installs the the templates package to current .templateengine cache
  • 2: Tries to create a project from each one, restore it, and build it
• After invoking the build script your template should be listed among dotnet new -all