README
1.. |(version)| replace:: 0.6
2
3========
4geanyprj
5========
6
7.. contents::
8
9About
10=====
11
12geanyprj is alternative project manager for Geany fast light IDE.
13
14Why it was created?
15-------------------
16
17Open source is great, there are a lot of nice sources that you can use for your projects
18in Internet. But there are also a lot of crappy sources and when you want steal something
19you need to check if it is good or not. Ability to jump to definition/declaration and back is
20great help for such task. But no other text editor or IDE I know allow this without a lot of setuping.
21You have to create/import project add files. When you finish with one project
22you need to close it and repeat procedure for all other. Great time wasting. If you are checking
23about 10 potential places you want steal code from, you won't create any project and don't
24get "jump to definition/declaration" just because it is too much bother.
25
26geanyprj aims to provide "jump to definition/declaration" functions with as little setup as possible.
27
28Why different project manager, why don't improve existing code in Geany?
29------------------------------------------------------------------------
30
31That's because current project manager in Genny more about sessions. It is not something real
32project manager should do (IMHO). It allow/require user manually open/close project and allow
33to store project files in different locations from project sources.
34
35geanyprj takes different approach:
36
371) Never save session information (this way project files can be stored in version control without
38constant noise from changes of opened files or cursor position)
39
402) Never open/close project manually. If .geanyprj file is found somewhere up in path it will be
41opened automatically.
42
43Usage
44=====
45
46geanyprj add "Tools->Project" menu and sidebar "Project" tab.
47
48Project properties
49------------------
50
51Name - This is just project name you will see it in status window on open/close project.
52
53Location - This is directory where .geanyprj file will be saved.
54
55Base Path - If defined Geany will use this directory as current directory for make and run commands
56
57Generate file list on load - This option tell Geany to recreate project file list on project load using
58selected type. If it is unchecked you should manually select files you want to be parsed by tagmanager.
59
60Type - This is type of files that needed to be parsed by tagmanager.
61
62* All - All files that is known to Geany
63* C/C++ - This match any C or C++ files (.c, .cpp, .cxx, .h etc.)
64* C - This match only C files (.c, .h)
65* Python - This match python files (.py)
66* None - This doesn't match any files
67
68
69Example of usage
70----------------
71
72Lets see plugin work at Geany source code example:
73
741) Download geany-0.15.tar.gz (https://download.geany.org/old/geany-0.15.tar.gz)
75
762) Unpack it somewhere, for example in ~/src/geany-0.15
77
783) Open ~/src/geany-0.15/configure.in
79
804) Click "Tools->Project->New Project", and click "Create" button
81
82 This will create and save .geanyprj file in ~/src/geany-0.15. From now, every time you
83 open file from ~/src/geany-0.15 dirrectory or it's subdirrectory .geanyprj will be opened.
84 So next time you don't have to create or open project manually.
85
865) Open any geany source code code file
87
88 "go to tag declaration/definition" should work for any geany function. (Not limited to opened files).
89
906) Now you open file that doesn't belong to Geany. For example ~/src/myprj/a.c Geany project will be closed. If ~/src/myprj/.geanyprj exists it will be opened as current project.
91
927) Switching back to any Geany file will open Geany project again.
93
94
95License
96=======
97
98geanyprj is distributed under the terms of the GNU General Public License
99as published by the Free Software Foundation; either version 3 of the
100License, or (at your option) any later version. A copy of this license
101can be found in the file COPYING included with the source code of this
102program.
103
104Ideas, questions, patches and bug reports
105=========================================
106
107If you add something, or fix a bug, please send a patch (in 'diff -u'
108format) to the geany mailing list or to one of the authors listed bellow.
109
110Coding
111======
112
113Use static functions where possible.
114Try to use GLib types and functions - e.g. g_free instead of free and
115try to use only GLib 2.6 and GTK 2.6 functions.
116
117Style
118=====
119
120The file indent-all.sh contains information about
121the current code style. Run this script before commit.
122
123Download
124========
125
126geanyprj is part of the combined Geany Plugins release.
127For more information and downloads, please visit
128http://plugins.geany.org/geany-plugins/
129
130Development Code
131================
132
133Get the code from::
134
135 https://github.com/geany/geany-plugins
136
1372007-2008 by Yura Siamashka
138yurand2(at)gmail(dot)com
139