@manuth/generator-wsc-package/templates/package/README.md

A Generator for WoltLab Suite Core Packages.

# <%= Name %>
<%- Description %>

## Building the Package
### Using Visual Studio Code
There are pre-defined build-scripts inside the workspace.  
This allows you to build the package by simply pressing <kbd>CTRL</kbd>, <kbd>SHIFT</kbd>+<kbd>B</kbd>.

The package will be built created as a `.tar`-package.

### Using a Console
#### Building the Package
You can build the package using the following command:

```bash
npm run package
```

This will create the package as a `.tar`-file.