Mercurial > pysmcl
changeset 131:8f4dbf37a96f
Added description of Eclipse plugin readme file.
author | Thomas P Jakobsen <tpj@cs.au.dk> |
---|---|
date | Thu, 29 Oct 2009 16:58:48 +0100 |
parents | 1c96a5080899 |
children | 4e2a22493116 |
files | eclipse/doc/readme.txt |
diffstat | 1 files changed, 44 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eclipse/doc/readme.txt Thu Oct 29 16:58:48 2009 +0100 @@ -0,0 +1,44 @@ + +User guide for the PySMCL Eclipse Plugin +======================================== + +Installation +------------ + +1) Install the Python PySMCL compiler on your system. + + This can be done by issuing + + hg clone http://hg.viff.dk/pysmcl + +2) Place the eu.cace.pysmcl.jar file in the eclipse/plugin folder and + restart eclipse. Under some circumstances Eclipse will cache its + plugins for performance reasons and you then have to run Eclipse + with the --clean flag. + + +Configuration +------------- + +In Eclipse you must select Preferences -> PySMCL. In the + + Python VM Location + +you must specify the absolute path to your Python interpreter. The +compiler currently only supports Python 2.6. In the + + PySMCL Location + +field you should put the absolute path to the base directory of +your PySMCL compiler, e.g. the folder that was created when you +issued the hg command above. + + +Usage +----- + +To enable or disable PySMCL warnigns, right click on any project, +e.g. in your Package Explorer, Project Explorer, or similar, and +select Add/Remove PySMCL Warnings. When enabled the PySMCL compiler is +automatically run every time you add or change a .py file and you will +see the new PySMCL warnings where appropriate.