Skip to content

Latest commit

 

History

History
64 lines (49 loc) · 1.86 KB

README.md

File metadata and controls

64 lines (49 loc) · 1.86 KB

Pearl Package Template

Project Status Communication
Build status Join the gitter chat at https://gitter.im/pearl-core/pearl

Table of Contents

How to use this template

Copy the content of this template and use it for creating new Pearl Packages.

The directory tests containg a template for doing unit and integration tests. The integration tests can be run via Travis CI.

To run the unit tests:

    ./tests/unit-tests/unit-tests.sh

Follow the main Pearl CONTRIBUTING file for more details.

Description

Introduce in this section the following information:

  • name: <pearl package name>
  • description: The package description
  • author: Creator name/surname
  • username: Creator username
  • OS compatibility: linux, osx, cygwin, any

Quickstart

Introduce the quickstart here for the pearl package.

Installation

This package can be installed via Pearl system.

pearl install <pearl package name>

Dependencies

The main dependencies are the following:

Troubleshooting

This section has been left blank intentionally. It will be filled up as soon as troubles come in!