vcs.maemo.org Git - feedingit/blob - psa_harmattan/feedingit/deb_dist/feedingit-0.1.0/README.assistant

   1 =========================================
   2 README - pyside-assistant generated files
   3 =========================================
   4
   5 All files generated by psa init are described below. The sampleproject
   6 slug used for them was 'sampleproject', with the following psa call:
   7
   8     $ psa init sampleproject <fremantle|harmattan|...>
   9
  10 For a complete list of templates available, use:
  11
  12     $ psa list
  13
  14 * MANIFEST.in: Distutils considers a list of files by default for
  15 installation, listed at [1].  Additional files to be distributed
  16 must be supplied in the MANIFEST.in file. The generated file includes
  17 the .desktop file and any QML files found.
  18
  19 [1] http://docs.python.org/distutils/sourcedist.html#specifying-the-files-to-distribute.
  20
  21 * setup.py: The main file for using Distutils, contains most of the
  22 information needed to build the package. Information about setup.py
  23 can be found at http://docs.python.org/distutils/introduction.html.
  24 Two fields of this file can be modified by psa update parameters:
  25  - description: -d or --description
  26  - long_description: the contents of sampleproject.longdesc are used
  27
  28 * stdeb.cfg: Configuration file for stdeb, specifying additional
  29 parameters for the binary package. The specification for this
  30 file can be found at https://github.com/astraw/stdeb, in the section
  31 stdeb.cfg configuration file. One field of this file can be modified by
  32 psa update parameters:
  33  - Section: -s or --section
  34
  35 Note that the section should be a valid one,
  36 as specified in http://wiki.maemo.org/Task:Package_categories#New_list_for_Diablo.
  37
  38 * sampleproject.aegis: Sample credentials file, which initially is empty. Information
  39 of how to populate it can be found at [2].
  40 NOTE: this file is used only in harmattan projects.
  41
  42 [2] http://library.developer.nokia.com/topic/MeeGo_1.2_Harmattan_API/html/guide/html/Developer_Library_Developing_for_Harmattan_Harmattan_security_6cbe.html
  43
  44 * sampleproject.desktop: This file specifies how to run the application
  45 from the application grid, with various fields. Information about
  46 .desktop files can be found at http://wiki.maemo.org/Desktop_file_format.
  47 Two fields of this file can be modified by psa update parameters:
  48  - Name: -a or --app-name
  49  - Category: -c or --category
  50
  51 Note that the category should be a valid one, as specified in
  52 http://standards.freedesktop.org/menu-spec/latest/apa.html.
  53
  54 * sampleproject.png: The application icon, which is displayed in the
  55 application grid.
  56
  57 * qml/*.qml: The QML files for the application. Their contents depend
  58 on the platform.
  59
  60 * sampleproject: Main program. Initializes the application and provide
  61 support for displaying the QML files contents.
  62
  63 * sampleproject.longdesc: Holds the contents of the long_description field of
  64 setup.py, which as the name implies is a more detailed description of what the project is.
  65