Revision: 265 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=265&view=rev Author: frlan Date: 2008-10-29 19:39:51 +0000 (Wed, 29 Oct 2008)

Log Message: ----------- GeanyLaTeX: Update of README

Modified Paths: -------------- trunk/geanylatex/README

Modified: trunk/geanylatex/README =================================================================== --- trunk/geanylatex/README 2008-10-29 19:39:32 UTC (rev 264) +++ trunk/geanylatex/README 2008-10-29 19:39:51 UTC (rev 265) @@ -0,0 +1,114 @@ +GeanyLaTeX Plugin +(Version 0.2, October 2008) + + +About +------ + +GeanyLaTeX is a little plugin to improve support of LaTeX at Geany. It +implements a wizard to create new LaTeX documents in a fast and easy +way. Also it implements a front end for add labels and refs as well as +special characters to an open document. + + +Requirements +------------ + +For compiling the plugin yourself, you will need the GTK (>= 2.6.0) +libraries and header files. You will also need its dependency +libraries and header files, such as Pango, Glib and ATK. All these +files are available at http://www.gtk.org. + +And obviously, you will need have Geany installed. If you have Geany +installed from the sources, you should be ready to go. If you used a +prepared package e.g. from your distribution you probably need to +install an additional package, this might be called geany-dev or +geany-devel. Please note that in order to compile and use this plugin, +you need Geany 0.15 or later (Geany Plugin API v100 or higher). + +Furthermore you need, of course, a C compiler (that is supporting C99) +and the Make tool. The GNU versions of these tools are recommended. +Also there should be a working (La)TeX-environment on your System. + + + +Installation +------------ + +Compiling and installing the code is done by the following three +commands: + +$ ./configure +$ make +$ make install + +For more configuration details run +$ ./configure --help + +If there are any errors during compilation, check your build environment +and try to find the error, otherwise contact one of the authors. (See below) + + +Usage +----- + +After installed successfully, load the plugin in Geany's plugin manager +and a new sub menu in the Tools menu will appear. Inside the sub menu +you will find entries for functions supported by this version of the +plugin. + + +Configuration +------------- + +No general configuration is needed to use the plugin. Nevertheless if +you want improve and make usage of all feature, you can define some +key bindings using Geany's key binding interface from inside the +preferences dialog. + + + +Development +----------- + +You can checkout the current source code from the Subversion repository at +Sourceforge.net. Get the code from: + +svn checkout +http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanyla... + +If you want to create a patch, please respect the license of GeanyLaTeX +as well as intellectual property of third. Patches that should be +included to the default distribution must be licensed under the same conditions +as GeanyLaTeX by the copyright owner. + + +Known issues +----------- + +At time of the the documentation was created no issue were known. +Since this is only a snapshot, you will find more recent information +for all reported issues bug tracking system of SF at +http://sourceforge.net/tracker/?group_id=222729 + + +License +------- + +GeanyLaTeX and all its parts is distributed under the terms of the +GNU General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any +later version. A copy of this license can be found in the file COPYING +included with the source code of this program. If not, you will be +able to get a copy by contacting the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + +Bugs, questions, bugs, homepage +--------------------------------- + +If you found any bugs or want to provide a patch, please contact Frank +Lanitz (frank(at)geany(dot)org). Please also do so, if you got any +questions and visiting http://frank.uvena.de/en/Geany/geanylatex/ +didn't help you to figure out the answer. Visiting the website is also +a good start if you want to check for any update on this plugin.

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.