erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
spiegel-keyman/developer/docs/help/guides/distribute/tutorial/step-1.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo 
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

1.2 KiB
Raw Blame History

title: Step 1: What do we include?

What is the purpose of a package? To make installation of a keyboard, fonts, documentation, and on screen keyboard as straightforward as possible for the end user.

We need to keep this goal in mind as we work on all the aspects of a package.

A good package will:

  1. Collect the keyboard and font files together for simple installation
  2. Include Start Menu items for documentation

A great package will also:

  1. Include a 'readme' visible before install.
  2. Include a 'welcome.htm' file which is displayed after install.
  3. Include an On Screen Keyboard if relevant.
  4. Include documentation on use of the keyboard.

Packages uploaded to the Tavultesoft website will get basic icon ratings reflecting their ease of install/use:

  • includes fonts
  • includes documentation
  • includes on screen keyboards
  • includes welcome.htm

In general, the more icons that a package earns, the easier that end users will find it to start using.

Step 2: Creating Additional Files for the Package