Changes between Version 8 and Version 9 of Obsolete/WorkInProgress/3rdparty guidelines


Ignore:
Timestamp:
Jun 5, 2011, 7:52:19 PM (9 years ago)
Author:
pulkomandy
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Obsolete/WorkInProgress/3rdparty guidelines

    v8 v9  
    66 * It should work on the latest stable release of Haiku
    77 * It should work on gcc2 hybrid - other flavors of Haiku may be ignored
    8  * configuration files should go in B_USER_SETTINGS_DIRECTORY; and the path should be obtained by the appropriate functions & constants, not hardcoded - use find_directory() ([http://ports.haiku-files.org/wiki/FindDirectory Examples for porting]).
    9  * The app must not write anything to the hard disk except in its own directory (B_APPS_DIRECTORY/AppName, or whatever the user installed it), the configuration directories (B_USER_SETTINGS_DIRECTORY, B_COMMON_SETTINGS_DIRECTORY), unless the user explicitly asks for it (a save dialog is a good example). <-- This makes little sense, as an application usually won't have the rights to write anything into its own directory. It may write to the user's cache, data, or settings directory, though, and that's pretty much it (axeld).
     8 * configuration files should go in B_USER_SETTINGS_DIRECTORY; and the path should be obtained by the appropriate functions & constants, not hardcoded - use find_directory() ([http://ports.haiku-files.org/wiki/FindDirectory Examples for porting]). If the application has system-wide settings (not per-user), they should go in B_COMMON_SETTINGS_DIRECTORY. Note this distinction is so far only cosmetical, since Haiku is not yet capable of multi-user running. But it's etter to do it right from the start to make your application more future-proof.
     9 * Beside the settings directory, applications may write data in other places in the config folder. Examples include the user cache and data folders.
     10 * Applications should be self-contained, that is, all the files needed to run them should be in a single folder in B_APPS_DIRECTORY/ApplicationName. This is very different from the usual UNIX filesystem hierarchy (with binairies in "bin", and data in "share" or "etc"). This makes it simpler to track disk usage for each application, and allows having multiple versions of the app installed at the same time (in different folders). Note this folder should not be written to. Use the various configuration folders mentionned above, one ofthem should fit your needs.
    1011
    1112 * HIG compliance (e.g. sentence casing, colour scheme, vector icons): it's better if your application fits in the look&feel of the whole system.
     
    1617= Other helpful resources =
    1718 * [http://ports.haiku-files.org/wiki/PortingTips HaikuPorts Porting Tips]
     19
     20= Asking for help =
     21 * Join the #haiku channel on irc.freenode.org to get in touch with the developpers
     22 * Send mails to haiku-3rdparty-dev@freelists.org mailing list. Some Haiku developpers will be able to answer you if in doubt with guideline compliance.