*** empty log message ***
[anjuta-git-plugin.git] / README
blobebceecb7f52800b861a68bbbbf062324b6c43b13
1                          Anjuta Version 2.0.0 Alpha Release
3                        Copyright (C) 2000-2005 Naba Kumar
4                        Home site => http://anjuta.org/
6 Introduction:
7 -------------
9 Anjuta DevStudio is a versatile Integrated Development Environment (IDE)
10 on GNOME Desktop Environment and features a number of advanced
11 programming facilities. These include project management, application and
12 class wizards, an on-board interactive debugger, powerful source editor,
13 syntax highlighting, intellisense autocompletions, symbol navigation,
14 version controls, integrated GUI designing and other tools.
16 Anjuta is an effort to marry the flexibility and power of text-based 
17 command-line tools with the ease-of-use of the GNOME graphical user 
18 interface. That is why it has been made as user-friendly as possible.
20 Anjuta 2.x is the next generation Anjuta development studio with extensible
21 plugin architecture. There has been a complete change in architecture of
22 Anjuta since 1.x series. The new architecture allows writing independent
23 plugins that could interact with existing plugins. Most of the older
24 features have been already ported to the new architecture and are working.
26 The new architecture has:
28     * Complex docking shell that allows arbitrary docking of IDE widgets.
29     * Dynamic plugin activation and deactivation.
30     * Extensible architecture.
31     * Plugins can interact with other plugins through interface.
32     * Plugins can install dynamic UIs (menus/toolbars), including installing
33           context menus in other plugins.
35 At present, Anjuta is only a beta release and lots of work needs to be done to 
36 improve it. In the future, Anjuta is going to be much more capable and stable! 
37 Extensive debugging has not yet been performed, so at the moment it will 
38 undoubtedly have lots of bugs. It would be great if you use it and report any 
39 problems to us. That way, you will be helping to improve the software as well 
40 as helping the Open Source community. Please read the file COPYRIGHT for
41 details. 
43 Any sort of suggestions or patches for Anjuta are also most welcome. 
45 Copyright (C) 2000-2002 Naba Kumar <naba@gnome.org>
46 ---------------------------------------------------
48 This program is free software; you can redistribute it and/or modify it under
49 the terms of the GNU General Public License as published by the Free Software
50 Foundation; either version 2 of the License, or (at your option) any later
51 version. 
53 This program is distributed in the hope that it will be useful, but WITHOUT
54 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
55 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
57 You should have received a copy of the GNU General Public License along with
58 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
59 Place, Suite 330, Boston, MA 02111-1307 USA 
62 Presently available features in Anjuta:
63 ---------------------------------------
65         1. Fully customizable integrated editor.
66                 o Automatic syntax highlighting.
67                 o Automatic code formatting.
68                 o Code folding/hiding.
69                 o Line numbers/markers display.
70                 o Text zooming.
71                 o Code autocompletion.
72                 o Calltips for Linux/GNOME function prototypes.
73                 o Automatic indentation and indentation guides.
74                 o ... and much more.
75         
76         2. Each file opened can be operated in either paged mode
77         or windowed mode. 
78         
79         3. Highly interactive source level debugger (built over gdb).
80                 o Interactive execution.
81                 o Breakpoints/watches/signal/stack manipulation.
82                 o Local Variables view.
83                 o Variables tips.
84                 o ... and much more.
85         
86         4. Inbuilt application wizards to create terminal/GTK/GNOME
87         applications on-the-fly. 
88         
89         5. Dynamic Tags browsing.
90                 o Function definition, structure, classes etc.
91                 o Full tags management for project.
92                 o Symbol Browser.
93                 o File Brwoser.
94         
95         6. Full project and build files management. 
96         
97         6. Bookmark management.
98         
99         7. Basic windows are attachable and detachable.
101         9. Support for other languages 
102                 o Java, Perl, Pascal ... etc. (only file mode, no project
103                 managements).
105         10. Interactive messaging system.
107         11. GNOME2 platform compliant.
108         
109 Contact Email addresses for Anjuta:
110 -----------------------------------
112 Anjuta Home site:       http://anjuta.org.
113 Anjuta Project site:    http://www.sourceforge.net/projects/anjuta
115 For general discussions and queries use the discussion forums (two forums) 
116 at the project site. Please report bugs at the projects bug tracking system
117 or the mailing lists at the project site. News of Anjuta is also available
118 at the project site.
120 To subscribe to one or more of the mailing lists, visit 
121 [ http://www.sourceforge.net/mail/?group_id=14222 ].
122 or send a mail at <listname>-request@lists.sourceforge.net with a subject 
123 just "subscribe". Where, <listname> is anjuta-list or anjuta-devel.
125 Mailing lists:
126         o anjuta-list@lists.anjuta.sourceforge.net
127                 For general discussion.
128         
129         o anjuta-devel@lists.anjuta.sourceforge.net
130                 For development discussion.
132         o anjuta-announce@lists.anjuta.sourceforge.net
133                 For announcements of new releases.
135 -------------
136 REQUIREMENTS:
137 -------------
139 Installation should be a breeze on any reasonably up-to-date *NIX system
140 with GNOME 2.x .The following are the minimum requirements. Until the code
141 reaches some kind stability it is always good to use the latest stable
142 version of the libraries
144 1) Installation
145 # From Tarball:
146         * GTK libs (2.0 or later)
147         * GNOME libs (2.0 or later)
148         * gnome-xml (aka libxml1) (1.4.0 or later)
149         * gnome-print
150         * gdk-pixbuf
151         * scrollkeeper
152         * pkgconfig
153         * gnome-build (from GNOME CVS, no tarball yet)
154         * gdl (from GNOME CVS)
156         Optional:
157         * glade3 (from GNOME CVS) to build glade plugin
158         * libsvn (www.subversion.org) to build subversion plugin
159         * graphviz
161 # From CVS:
162         * All the requirements for tarball
163         * GNU gettext 0.10.x (or later)
164         * Automake 1.4 (or later)
165         * Autoconf 2.13 (or later)
167 2) Running
168         * X-Windows, any window manager should do as long
169         as the gnome libs are installed)
170         * Bash command shell
171         * GNU Indent
172         * yelp to browse docs
173         * Automake/Autoconf
174         * GNU Make
175         * GNU C/C++ compiler
176         * GNU debugger (gdb)
177         * GNU grep
178         * For cvs plugin: cvs
180 INSTALLATION:
181 -------------
183 # From Tarball:
184         Note:- The package as an example is taken as anjuta-1.0.tar.gz
185         and '#' is the shell prompt. You must be logged in as root to
186         install Anjuta.
188         1) Get the tarball
189         2) copy it to your home dir.
190         3) tar xfzv anjuta-<version>.tar.gz
191         4) Change dir:   # cd anjuta-<version>
192         5) Type:  # ./configure
193         6) Type:  # make
194         7) Type:  # make install
196         That's all. If everything went smoothly, congratulations. If not,
197         then please check that you have the latest libgnome and libgnomeui
198         installed. Get them if you don't have and repeat the above steps.
201 KNOWN ISSUES:
202 -------------
203         * Printing is unstable with older versions of gnome-print and FreeType.
204         If you experience crashes while printing, please upgrade gnome-print
205         and FreeType to the latest stable versions (currently 0.36 and 2.1.2
206         respectively).
207         
208         * Debugger stepping may not work correctly if executables are compiled
209         with optimization enabled (This is a GCC/GDB issue). If you plan to
210         debug your application from Anjuta, please turn off optimization for
211         debug builds.
213         * Calltips flicker when the cursor touches them if you have your window
214         manager set to follow-mouse-cursor for focus. Change it to focus-follow
215         mouse click to fix it.
216         
217 RUNNING:
218 --------
220 To run Anjuta, choose Development->Anjuta from the GNOME Main Menu, 
221 or type:   # anjuta
223 If you get the shell error 'Command not found', then make sure your PATH
224 variable contains the executable path of Anjuta binary (by default:
225 /usr/local/bin). Usually, the PATH variable is set in the file
226 /etc/profile. Check it out.
228 Usage: anjuta [--no-splash | -s] [ files ...] [ project ]
230 If you do not want to see the Anjuta splash screen / logo, run Anjuta with 
231 the command-line option "--no-splash". See the User Manual for further
232 instructions.
235 ** Good Luck **