Skip to content
Cornelius Schumacher edited this page Oct 11, 2013 · 3 revisions

Here are some guidelines how to write the manifests.

General

  • Write towards the audience of Qt application developers.
  • Write the texts in a neutral and objective way. Avoid advertising language and filler buzzwords like "easily", "quick", etc. Focus on the value of the information.

Name

  • The name of the library should be a string which is easy to handle from a program, but still is readable by humans.
  • The name should be all lower-case.
  • If it's a Qt binding to another library, make the name of the format "library-qt", where "library" is the name of the original library, which is wrapped, unless the bindings are explicitly released under a specific different name.

Licenses

  • Provide a list of all licenses the code is released under. Usually there is a LICENSE or COPYING file in the source code. You might also have to look at some source files to see what exact license is applied, e.g. for checking if it's a specific GPL version or if it also includes later versions.

Authors

  • Include at least one author, which is reasonably to be expected to act as point of contact.
  • Try to make the author entry of the form "Real Name [email protected]".
  • Use real names, not nicknames.
Clone this wiki locally