Mycroft Skill Readme Generator

This tool generates a README.md for your Mycroft Skill repository on GitHub. It will be machine-parsed to fill the Mycroft Skill Marketplace and will explain your Skill to users in a standardized, easy to read format.

How it works

Edit the form
Generate and examine previews
Copy the output into a README.md file for your Skill's repo

optionally

Edit or Paste an existing README.md in the README tab.

Documentation is also available on writing Skills for Mycroft, and you are welcome to join the Skills development Chat channel, where you can liaise with other Skill Authors and request assistance.

Name Brief, speakable skill name. Capitalize most words. Ex: "Podcast Player".
NOTE: Avoid the word "Skill" in the name.

Icon

Preview:

Font Awesome Name / or image URL:

Color:

Go to Font Awesome, pick a free icon and copy its name here (eg. 'paw'), along with a color. Alternately, provide a full URL to your 50x50 icon image (.png or .jpg only).

One-line Description Enter a one-line description of your skill. Ex: "Play and subscribe to podcasts"
Long Description Free form, multi-paragraph description of the Skill. You can use Github markdown.
User Phrases: Hey Mycroft... Provide examples of phrases handled by the Skill after the Wake Word is spoken. The first may be highlighted and should be a prime example.
Ex: "play the news", "set a 10-minute timer"
Author(s) Credits for people or organizations involved (name, email, and/or GitHub @handle).
Supported Devices
All Devices (no specific requirements)

Specific devices
Platform: Mark I

Platform: Mark II

Platform: Picroft

Platform: KDE Plasmoid

If only for specific platforms, check one or more (blank means any platform).
Category
Daily — time, alarms, timers, and weather

Configuration — query and change account or device settings

Entertainment — jokes, sport scores, games

Information — stocks, quotes, general knowledge

IoT — home automation, lighting controlling

Music & Audio — listen to streaming services

Media — controlling video streamer, stereo

Productivity — mail, calendar, Pomodoro

Transport — bus/train schedules, ride services
The first Category selected will be bold as the Primary Category for display, all others are secondary for searches.
Tags Tags are single word identifiers, such as #kids, #crypto and are used for searching.
Custom Sections Optional: You can add one or more custom sections to be included in your readme. These won't appear inside the Marketplace, but can describe any information another developer might be interested. History, how to build associate hardware, references to other projects ... just use regular Github markdown.

For help, see the ~skills channel at https://chat.mycroft.ai.

Below is a preview of how the README.md will look in your Skill's Github repo.

Below is a preview of a small reference card.

Tester

Coin Flip

testing

This is a shortish description for the Skill

Below is a preview of a large reference card.

Coin Flip

This is a shortish description for the Skill

testing

This is the full description for the Skill

Credits:
By whoever (@whoever)

Below is the basis of the README.md for your Skill's Github repo. You can safely extend the contents with a custom sections below the generated content, such as ## Notes or ## TODO. But refrain from changing the format or order of the generated content to ensure compatibility with parsers.

README.md changes applied
NOTE: Edits made here will be applied back to the edit form and previews. Be aware that non-standard README features can be lost in the round-trip after you leave this page.