Dart Package Template

Version: 0.8.0

This repository acts as a template repository for all dart packages released by zamstation.

When a repository is created using this template, one must go through the following checklist to prepare for the first commit.

CHECKLIST

- [ ] Setup

• Rename this file to guide.md.
• Rename original_README.md to README.md

pubspec.yaml

• In name field, replace package_name with your package name.
• In description field, add description not less than 60 characters.
• In repository field, replace package_name with your package name.
• In dependencies field, remove zam_core if not needed.

README.md

• Replace @package_title@ with package title.
• Replace @description@ with description.
• Replace 14 occurences of @package_name@ with package name.
• Replace 6 occurences of @component_n@ with component names.
• Replace @how_to_use@ with usage and examples.
• Add contributors as necessary.

.github/workflows/build_workflow.yaml

• Remove "**" from branches-ignore array. Leave ignore.

.github/workflows/release_workflow.yaml

• Remove "**" from tags-ignore array. Leave ignore.

lib/package_name.dart

• Rename package_name.dart to @package_name@.dart
• Add your files.

test

• Remove dummy_test.dart when you have created your first test. You need to have at least one test to satisfy the publish.sh script.
• Remove _setup.dart if not required.

example/lib/main

• Add your example.

CHANGELOG.md

• Replace @component_n@ with your component names.

guide.md (This File)

• Remove this file.