home *** CD-ROM | disk | FTP | other *** search
/ linuxmafia.com 2016 / linuxmafia.com.tar / linuxmafia.com / pub / palmos / pippy-0.6beta-src.tar.gz / pippy-0.6beta-src.tar / pippy-0.6beta-src / docs / BUILD next >
Text File  |  2001-02-23  |  6KB  |  192 lines
  1. Pippy - The port of Python to the Palm OS.
  2.  
  3. This is Pippy 0.6beta.
  4.  
  5. Copyright (c) 2001 Endeavors Technology, Inc.
  6. All rights reserved.
  7.  
  8.  
  9. This document describes the process for building the Pippy application.
  10.  
  11.  
  12. COPYRIGHT/LICENSE
  13.     License and copyright issues are discussed in the file: LICENSE
  14.  
  15.  
  16. BUILDING AND INSTALLING Pippy
  17.  
  18.     WARNING: Backup your Palm device before installing Pippy!
  19.  
  20.  
  21. 0. It is assumed that you have already installed the necessary tools.
  22.    See file: TOOLS
  23.    
  24.     Be sure that you have installed and are using Python Version 1.5.2+ on
  25.     your system.  Other versions will not completely work.  In particular,
  26.     Python 2.0 bytecodes are incompatible with this revision.
  27.  
  28. The following instructions are specific to Unix/Linux.
  29.  
  30. 1.  Download the Pippy source distribution: pippy-0.6beta-src.tar.gz
  31.     <http://www.endeavors.org/pippy.html>
  32.  
  33. 2.A Unpack the pippy-0.6beta-src.tar.gz distribution into your working
  34.     build directory.  For example,
  35.     
  36.     mkdir pippy-0.6beta-src
  37.     cd pippy-0.6beta-src
  38.     gzip -dc pippy-0.6beta-src.tar.gz |tar -tvf - 
  39.  
  40.     You should now have the following subdirectories:
  41.         docs/
  42.         patches/
  43.         src/
  44.         tools/
  45.     
  46.  
  47. 2.B The module palmappsmodule.c requires the Palm SDK Examples
  48.     distribution (downloadable from <http://www.palmos.com/dev/tech/tools/>). 
  49.     Obtain the Examples distribution and install it.
  50.  
  51.     Set the variable PALM_EXAMPLES in the file ./src/Palm/Modules/Setup
  52.     to the full path of the  Examples distribution.  For example, if you
  53.     installed the Examples distribution in a directory called PALM off
  54.     of your home directory (assumed to be /home/palmuser, for example),
  55.     you would set:
  56.     
  57.         PALM_EXAMPLES = /home/palmuser/PALM/Examples
  58.  
  59.  
  60. 3.  The next step involves building the pylib.prc and pippy.prc files.
  61.     Perform the following commands at the shell prompt:
  62.     
  63.         cd ./src/Palm
  64.         make
  65.         cd Interactive
  66.         make
  67.  
  68.  
  69. 4.  Your .prc files should now be located in:
  70.     ./src/Palm/pylib.prc 
  71.     ./src/Palm/Interactive/pippy.prc
  72.  
  73. 5.  Install prc files
  74.  
  75.     WARNING: Backup your Palm device before installing Pippy!  
  76.  
  77.     Install the generated .prc files
  78.     (./src/Palm/pylib.prc and
  79.     ./src/Palm/Interactive/pippy.prc) on your Palm
  80.     (using something like pilot-xfer) or POSE.
  81.  
  82.     For example:
  83.     If your Palm cradle is connected to /dev/ttyS1 (serial port) on your
  84.     Linux box, and the palm is set into the cradle, the following will
  85.     install the files:
  86.     
  87.     Assuming you are in the directory pippy-0.6beta-src (that you created above):
  88.     
  89.     pilot-xfer -p /dev/ttyS1 -i ./src/Palm/pylib.prc ./src/Palm/Interactive/pippy.prc
  90.  
  91. 6.  Once the .prc files are installed you can remove the Palm from the cradle
  92.     and startup Pippy just as you would any other Palm application.
  93.      
  94.  
  95. INCLUDING YOUR OWN MODULES OR APPLICATIONS
  96.  
  97. To include your own special modules, build an application or to include
  98. the standard python library modules, you must perform the following:
  99.  
  100. 1.A  Create a file (wrapper.py, for example) in the Interactive directory.
  101.     This file should contain the Python import statements for the modules 
  102.     you wish to include.
  103.  
  104. 1.B Prepend the Linux environment variable PYTHONPATH with 
  105.     the full path to Pippy Lib directory.  For example, if you installed
  106.     Pippy distribution in the directory pippy-0.6beta-src/ off your home
  107.     directory (assumed to be /home/palmuser) the you need to modify your
  108.     PYTHONPATH to include:
  109.     
  110.     export PYTHONPATH=\
  111.     /home/palmuser/pippy-0.6beta-src/src/Palm/Tests:\
  112.     /home/palmuser/pippy-0.6beta-src/src/Lib:\
  113.     /home/palmuser/pippy-0.6beta-src/src/Palm:$PYTHONPATH
  114.  
  115.     
  116. 1.C From the Linux command line (shell) enter the following commands:
  117.  
  118.     [NOTE: this assumes that you have already performed the make from 
  119.     the ./src/Palm directory to generate the pylib.prc file.]
  120.     
  121.         cd pippy-0.6beta-src/src/Palm/Interactive
  122.     
  123.     If you have previously done a make in this directory
  124.     you should do: make clean 
  125.     
  126.     Now perform the following commands from the shell prompt:
  127.     
  128.         ../Resourcer/resourcer wrapper.py
  129.         make
  130.  
  131.     The resulting pippy.prc will contain the library modules as Palm
  132.     resource records.
  133.  
  134. 2.  Install the pippy.prc file on your Palm.  This assumes you have already installed
  135.     the pylib.prc. [see Step 5 above, for example]
  136.  
  137.  
  138. RUNNING THE Python REGRESSION TESTS
  139.  
  140. 1. See the file: ./src/Palm/Tests/all_palm_tests.py
  141.  
  142. 2. create a wrapper.py file (as described above) that contains the line:
  143.  
  144.     import all_palm_tests
  145.     
  146.  
  147. 3. Build the pippy.prc file as per the instructions above and install
  148.     onto your Palm.
  149.    
  150.  
  151. 4. Start up Pippy on the Palm, and at interactive command line enter:
  152.        
  153.        import all_palm_tests
  154.  
  155.  
  156.  
  157. ADDITIONAL INFORMATION
  158.  
  159. See the README and TOOLS files.
  160.  
  161.  
  162. LINKS AND CONTACT INFORMATION
  163.  
  164.     Pippy Development Home
  165.     <http://www.endeavors.com/pippy.html>
  166.  
  167.     Feedback & General Comments
  168.     <pippy@endeavors.com>
  169.  
  170.     MAILING LISTS
  171.         Developer Issues
  172.         <pippy-dev@endeavors.org>
  173.         Bug Reports
  174.         <pippy-bugs@endeavors.org>
  175.         Announcements
  176.         <pippy-announce@endeavors.org>
  177.  
  178.     CVS REPOSITORY
  179.     <http://www.endeavors.com/pippy/download.html>
  180.  
  181.     Palm Developers Site
  182.     <http://www.palmos.com/dev/>
  183.  
  184.  
  185. AUTHORS
  186.  
  187.     Jeffery D. Collins <jcollins@endeavors.com>
  188.     Michael Gorlick <mgorlick@endeavors.com>
  189.     Endeavors Technology, Inc.
  190.     19700 Fairchild Rd, Suite 200
  191.     Irvine, CA  92612
  192.