Changeset 121

Show
Ignore:
Timestamp:
01/16/08 16:44:53
Author:
slee
Message:

Updated readme and made installer use relative paths

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • inapp/trunk/README

    r115 r121  
    1 Jambu In Application  
    2 ==================== 
     1Jambu In Application 0.0.3 
     2========================== 
    33 
    4 Operate an application from switches ot 2 keys by stepping through the UI. 
     4====================== 
     5* What is jambuinapp? 
     6====================== 
    57 
    6 This version works with GTK accessibile apps and has been tested with Minefield 
    7 and gedit. 
     8Jambuinapp allows you to operate an application from switches or keys by  
     9stepping around the UI rather than using an intermediate overlay (or OSK). 
     10It uses the accessibility features of the Linux GNOME desktop.  
    811 
    9 Dependencies 
    10 ------------ 
    11 GNOME Linux desktop 
     12This developer release works with Minefield (latest trunk version of Firefox 3) 
     13and GTK accessibile apps (has been tested with gedit). 
     14 
     15Jambuinapp is part of a larger Jambu project: 
     16  http://www.oatsoft.org/trac/jambu 
     17 
     18=========================== 
     19* Where to get jambuinapp? 
     20=========================== 
     21 
     22Get the installable tarball from 
     23 
     24  http://fullmeasure.co.uk/Jambu/jambuinapp-0.0.3.tar.gz 
     25   
     26Or grab the latest source from SVN at: 
     27 
     28  http://www.oatsoft.org/svn/jambu/inapp/trunk 
     29 
     30   
     31============================= 
     32* How to install jambuinapp? 
     33============================= 
     34 
     35Dependencies - what else you'll need 
     36------------------------------------ 
     37 
     38GNOME Linux desktop with accessibility options enabled 
    1239python: http://python.org 
    1340pygtk: http://www.pygtk.org/ 
    …… 
    1542pygame: http://www.pygame.org/ 
    1643 
    17 All latest versions (some may be available in distro's package repositries) 
     44* All latest versions (some may be available in your distro's package repositries) 
    1845 
    19 Installing 
     46In addition you'll want: 
     47Minefield (aka Firefox 3.0)  
     48          http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/latest-trunk/ 
     49 
     50           
     51Installing  
    2052---------- 
    21 1) Unzip the tarball (e.g tar xvf jambuinapp-0.0.1.tar.gz) 
    22 2) cd (e.g. cd jambuinapp-0.0.1) 
     531) Unzip the tarball (e.g tar xvf jambuinapp-0.0.3.tar.gz) 
     542) cd (e.g. cd jambuinapp-0.0.3) 
    23553) python setup.py install (note run as root or sudo) 
    2456 
    25 Source 
    26 ------ 
    27 Grab the latest from SVN at http://www.oatsoft.org/svn/jambu/inapp/trunk 
    28 and run .../jambuinapp/src/jambu python InAppSelection.py  
     57Or to make the tarball from the source run: 
     58  python setup.py sdist 
    2959 
    30 Useage 
    31 ------ 
    32 /usr/local/bin/jambuinapp --scan --showtree [gedit | Minefield] 
    33   --scan        start auto scanning, otherwise manual 
    34   --showtree    show the GTKTreeView of accesible objects and other UI 
     60========================= 
     61* How to use jambuinapp? 
     62========================= 
    3563 
    36 Make sure gedit/minefield is already open and make it the active application  
     64When installed run: 
     65 
     66 jambuinapp [--scan] [--showtree] Minefield | <other app name> 
     67   --scan       start auto scanning, otherwise manual 
     68   --showtree   show the GTKTreeView of accesible objects and other UI 
     69 
     70Or for local source execution run:  
     71  .../jambuinapp/src/jambu python InAppSelection.py Minefield 
     72 
     73Make sure Minefield is already open and make it the active application  
    3774again to be safe. 
    3875 
    …… 
    4077--------- 
    4178Use 'next' gesture to move around items and 'action' to enter a group of items or 
    42 perform the action for an interactive item. 'next' iterates arround items in a 
     79perform the action for an interactive item. 'next' iterates around items in a 
    4380group and also the group itself to allow moving up and out of the group  
    4481(the highlight changes colour in this case). 
    …… 
    4784invoke an OSK like GOK or Dasher. 
    4885 
    49 Gestures 
    50 -------- 
     86Actions and Gestures 
     87-------------------- 
    5188next item -> Left Ctrl key, USB Switch 0 or 4, middle mouse button 
    5289action item -> Right Ctrl key, USB switch 1 or 6, right mouse button 
    5390 
    54 Auto scan may be started/stopped with the 'Start Scan' button. 
     91For the mouse gestures you need to dispaly the UI and leave the pointer in the  
     92spaces between the buttons and menus do not display properly as the mouse 
     93interferes. 
    5594 
    56 For mouse you need to leave the pointer in the spaces between the buttons and  
    57 menus do not display properly as the mouse interferes. 
     95UserInterface 
     96------------- 
     97A tree view is presented for developer use. It shows the model of accessibles 
     98and provides buttons to (re)Generate the model, start/stop scanning and perform  
     99an action. 
    58100 
    59 Known Bugs 
    60 ========== 
    61 If highlight disappears simple do a next gesture. The temporary use of simulated 
     101 
     102============================= 
     103* What known bugs are there? 
     104============================= 
     105*If highlight disappears simply do a 'next' action. The temporary use of simulated 
    62106mouse click for minefield menues and buttons requires that the highlight be hidden. 
    63 Need to sort multi column selections + scrolling in selections. 
    64 Document only works with visible items, need scrolling to hidden items. 
     107*Need to sort multi column selections + scrolling in selections. 
     108*Web document only works with visible items, need scrolling to hidden items. 
    65109 
    66 Web site 
    67 -------- 
     110 
     111========================================= 
     112* Where can I find out more about Jambu? 
     113========================================= 
    68114http://www.oatsoft.org/trac/jambu 
    69  

  • inapp/trunk/setup.py

    r117 r121  
    2929      packages=['jambu'], 
    3030      scripts=['src/jambuinapp'], 
    31       data_files=[('/usr/local/share/doc/jambu', ['README', 'AUTHORS', 'LICENSE',  'NEWS', 'ChangeLog']), 
    32                   ('/usr/local/bin', ['src/jambuinapp'])], 
     31      data_files=[('share/doc/jambu',  
     32                  ['README', 'AUTHORS', 'LICENSE',  'NEWS', 'ChangeLog'])] 
    3333      ) 
    34