1
2Important note! If you are upgrading from an older installation, please note
3that the name of the script folder is now changed from /lua/ to /geanylua/ !!!
4
5
6
7These installation instructions are written primarily for a Linux system,
8followed by some additional notes for MS-Windows users.
9
10If you are installing from the pre-compiled Linux plugin package, you can
11just run the "install.sh" script, to install the plugin, examples, and help
12files into your ~/.geany/plugins directory.
13
14
15If you want Geany's syntax highlighter to recognize the plugin's function
16names you can also modify your  "filetypes.lua" file according to the notes
17in the "geanylua/keywords.list" file.
18
19
20For those of you who want to compile the plugin from scratch, keep reading...
21
22
23At the time of this writing, building the plugin requires a recent SVN checkout
24of the Geany sources (r2391+), and a properly installed copy of the Lua 5.1.x
25library, headers, and pkg-config script.
26
27
28Recent versions of Geany will now install all the necessary headers in
29$PREFIX/include/geany/ along with a pkg-config script that tells configure
30where to find the required files, so  the old --with-geany-src option
31is no longer required. Building should now be as simple as:
32
33 % configure
34 % make
35 % make install
36
37The "make install" command copies the files to your personal ~/.geany/plugins/
38directory, so you don't need to be root to install. If you actually do want
39everyone on the system to be able to access to the same copy of the plugin,
40you can add the --enable-sys-install option to the ./configure command line.
41
42
43To uninstall the plugin, you should be able to simply type "make uninstall"
44but be warned - although it will try not to remove any of your own personal
45scripts, the folder "geanylua/examples" and all its contents will always be
46removed unconditionally, so any scripts in the examples directory WILL BE LOST!
47
48
49
50===========================  MS-WINDOWS NOTES  ===============================
51
52The pre-compiled GeanyLua package includes a couple of Visual Basic scripts
53that I hope will simplify installation for most users. The scripts require a
54recent version of Geany (SVN-r2151 or newer) and the Windows VBS scripting
55engine. ( If you have at least Internet Explorer 5.0, you probably have VBS.)
56
57To install geanylua using the script, just double-click the "win32-install.vbs"
58file and if you don't see any error messages, you should be all set up.
59( Be sure to exit any running instance of Geany before installing! )
60
61If something goes wrong, you can try installing manually, as follows...
62
63To install the pre-compiled plugin on Windows, you can copy the "geanylua.dll"
64file to the "plugins" folder in the same place where Geany is installed, that
65would probably be "C:\Program Files\Geany\plugins\geanylua.dll" or somewhere
66like that.
67
68The exact location where Geany will look for the Lua script files depends on
69your Windows version, your Geany version, and possibly even your environment.
70
71For user "jane" it could be any one of these:
72
73Prior to Geany-SVN-2139, the paths would look something like this:
74
75Win2k:  C:\Documents and Settings\jane\.geany\plugins\geanylua\
76Win98:  C:\.geany\plugins\geanylua\
77MinGW:  C:\msys\1.0\home\jane\.geany\plugins\geanylua\
78
79
80As of Geany-SVN-2139, the configuration paths should be more like this:
81
82Win2k:  C:\Documents and Settings\jane\Application Data\Geanyplugins\geanylua\
83Win98:  C:\Windows\Profiles\jane\Application Data\Geany\plugins\geanylua\
84MinGW:  Geany's config path now ignores the $HOME environment variable.
85
86Just in case you aren't confused yet, anonymous users on Win98 may need to
87place the files in "C:\Windows\Application Data\Geany\plugins\geanylua\"
88
89
90If you want to compile the plugin from the sources on MS-Windows, you will
91need a fairly complete MSYS/MINGW/GTK build system, along with a properly built
92and installed "liblua.a" library, and the Lua headers. ( The "Win32_mingw3_lib"
93package from http://luabinaries.luaforge.net/ worked fine for me. )
94
95You also need a copy of the file "lua.pc" from the Lua sources somewhere in
96your $PKG_CONFIG_PATH. The libtool I used complains about missing symbols and
97refuses to build the DLL, so you may need to explicitly type "make win32"
98in order to produce the ".libs/geanylua.dll" file.
99
100The "make install" target is badly broken for Windows, so you will probably
101want to run the "win32-install.vbs" script, or copy the files manually
102to their required locations, as described above.
103
104