configure: fix build of vala plugin
[anjuta.git] / README
blobd918a2b9ac8b3ee167a5a0a37160e9370c76f155
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. We thrive to make it very usable by eleminating developers
19 burden with mudane programming tasks.
21 Anjuta 2.x is the next generation Anjuta development studio with extensible
22 plugin architecture. 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 Presently available features in Anjuta:
46 ---------------------------------------
48         1. Fully customizable integrated editor.
49                 o Automatic syntax highlighting.
50                 o Automatic code formatting.
51                 o Code folding/hiding.
52                 o Line numbers/markers display.
53                 o Text zooming.
54                 o Code autocompletion.
55                 o Calltips for Linux/GNOME function prototypes.
56                 o Automatic indentation and indentation guides.
57                 o ... and much more.
58         
59         2. Each file opened can be operated in either paged mode
60         or windowed mode. 
61         
62         3. Highly interactive source level debugger (built over gdb).
63                 o Interactive execution.
64                 o Breakpoints/watches/signal/stack manipulation.
65                 o Local Variables view.
66                 o Variables tips.
67                 o ... and much more.
68         
69         4. Inbuilt application wizards to create terminal/GTK/GNOME
70         applications on-the-fly. 
71         
72         5. Dynamic Tags browsing.
73                 o Function definition, structure, classes etc.
74                 o Full tags management for project.
75                 o Symbol Browser.
76                 o File Brwoser.
77         
78         6. Full project and build files management. 
79         
80         6. Bookmark management.
81         
82         7. Basic windows are attachable and detachable.
84         9. Support for other languages 
85                 o Java, Perl, Pascal ... etc. (only file mode, no project
86                 managements).
88         10. Interactive messaging system.
90         11. GNOME2 platform compliant.
91         
92 Contact Email addresses for Anjuta:
93 -----------------------------------
95 Anjuta Home site:       http://anjuta.org.
97 For general discussions and queries use the discussion forums (two forums) 
98 at the project site. Please report bugs at the projects bug tracking system
99 or the mailing lists at the project site. News of Anjuta is also available
100 at the project site.
102 To subscribe to one or more of the mailing lists, visit 
103 [http://mail.gnome.org/mailman/listinfo/anjuta-devel-list].
104 or send a mail at <listname>-request@gnome.org with a subject 
105 just "subscribe". Where, <listname> is anjuta-list or anjuta-devel-list.
107 Mailing lists:
108         o anjuta-list@gnome.org
109                 For general discussion.
110         
111         o anjuta-devel-list@gnome.org
112                 For development discussion.
114 -------------
115 REQUIREMENTS:
116 -------------
118 1) Installation from tarball:
119         * GTK libs (2.0 or later)
120         * GNOME libs (2.0 or later)
121         * gnome-xml (aka libxml1) (1.4.0 or later)
122         * gnome-print
123         * gdk-pixbuf
124         * scrollkeeper
125         * pkgconfig
126         * gnome-build (the latest release)
127         * gdl (the latest release)
129         Optional:
130         * devhelp (0.13 or later): for integrated API help
131         * glade3 (3.1.5 or later): for integrated UI designing
132         * libsvn: (www.subversion.org) to build subversion plugin
133         * graphviz: for class hierarchy view and profiler.
135 2) Installation from repository:
136         * All the requirements for tarball
137         * GNU gettext 0.10.x (or later)
138         * Automake 1.4 (or later)
139         * Autoconf 2.13 (or later)
141 3) Running
142         * X-Windows, any window manager should do as long as the gnome libs
143           are installed)
144         * Bash command shell
145         * GNU Indent
146         * yelp to browse docs
147         * Automake/Autoconf
148         * GNU Make
149         * GNU C/C++ compiler
150         * GNU debugger (gdb)
151         * GNU grep
152         * For cvs plugin: cvs
154 INSTALLATION:
155 -------------
157 Note:- The package as an example is taken as anjuta-1.0.tar.gz
158 and '#' is the shell prompt. You must be logged in as root to
159 install Anjuta.
161         1) Get the tarball
162         2) copy it to your home dir.
163         3) tar xfzv anjuta-<version>.tar.gz
164         4) Change dir:   # cd anjuta-<version>
165         5) Type:  # ./configure
166         6) Type:  # make
167         7) Type:  # make install
169 That's all. If everything went smoothly, congratulations. If not,
170 then please check that you have the latest libgnome and libgnomeui
171 installed. Get them if you don't have and repeat the above steps.
174 KNOWN ISSUES:
175 -------------
176         * Calltips flicker when the cursor touches them if you have your window
177         manager set to follow-mouse-cursor for focus. Change it to focus-follow
178         mouse click to fix it.
179         
180 RUNNING:
181 --------
183 To run Anjuta, choose Applications->Programming->Anjuta IDE from the GNOME
184 Main Menu, or type:   # anjuta
186 If you get the shell error 'Command not found', then make sure your PATH
187 variable contains the executable path of Anjuta binary (by default:
188 /usr/local/bin). Usually, the PATH variable is set in the file
189 /etc/profile. Check it out.
191 Usage: anjuta [--no-splash | -s] [ files ...] [ project ]
193 If you do not want to see the Anjuta splash screen / logo, run Anjuta with 
194 the command-line option "--no-splash". See the User Manual for further
195 instructions.
198 ** Good Luck **