readme

Linux下的C、C＋＋ IDE

	     		         hIDE
	      (Heterogeneous Integrated Development Environment)
-----------------------------------------------------------------------------

				Contents
				--------
1. Introduction
2. Current Features
3. Requirements
4. Building/Installing hIDE
5. hIDE Directory Structure
6. Bugs


_____________________________________________________________________________
1. Introduction

(NOTE: This is an ALPHA test  version of hIDE and many things will be added 
and changed in the final release.)

	hIDE is an IDE for developing applications using the C++, C or
Java programming languages. The end goal of the hIDE project is to create
a very flexible and consistent environment for software development. The
other goal of hIDE is ensuring it is *always* availble free of charge.
Most quality development tools are pricey (and alot aren't worth the price). 

	The hIDE software is provided as "open-source" C++ source code
which you are free to modify under the GNU GPL. This also means you have to
build hIDE yourself. This seems like extra work, but because it is provided
as open-source *we* as software developers can always continue to improve
hIDE.


_____________________________________________________________________________
2. Current Features

	~ C++, C and Java build tools integration (more are being added).

	~ Project management tools.

	~ Automatic makefile generation (Projects Only).

	~ Individual file compilation.

	~ main() file generation (Projects Only)

	~ Integrated source code editor with line\column numbering.

	~ Raw byte output viewer for any text based file.

	~ Ctrl+U and Ctrl+L shortcuts to convert selected 
	text to uppercase\lowercase.

	~ F7 shortcut to "Build" a project.
 
	~ Ctrl+F7 shortcut to compile a single C++ or C implementation file.

	~ Ctrl+M shortcut to run "make" for C++ and C.

	~ Ctrl+E shortcut to execute Java apps.

	~ File Browser.

	~ Class Browser.


_____________________________________________________________________________
3. Requirements

	~ Qt 3.x or greater.

	~ GCC & Binutils Tools.

	~ Some flavour of Linux (email me with any issues related
	to building on different flavors of *nix...
	[e-mail]).


_____________________________________________________________________________
4. Building/Installing hIDE

	1. cd into the directory that contains the hide sources.

	2. Run "make".

	3. Run "make install" (NOTE: Must be root to install).

	4. Add the HIDEPATH environment variable and set it to hIDE's
	directory.

	5. Add $HIDEPATH/bin to the PATH environment variable.

If no nasty errors came up (warnings generated are harmless) during the
build stages you should be ready to use hIDE. Simply execute "hide" and
the IDE should start. (NOTE: Your X-Windows manager must be running when
you start hIDE, ie: you must be in a GUI based *nix environment).


_____________________________________________________________________________
5. hIDE Directory Structure

      /hide	<--- hIDE Root ($HIDEPATH)
	|
	|__ /bin	<--- Executable Tools
	|
	|__ /conf	<--- Configuration Data
	|
	|__ /docs	<--- hIDE Documentation
	|
	|__ /foo	<--- Fully Object Oriented C++ Library
	|
	|__ /img	<--- Graphical Resources
	|
	|__ /include	<--- C & C++ headers
	|
	|__ /tmp	<--- Temporary Data


_____________________________________________________________________________
6. Bugs
	
	View the "BUGS" file for a list of all currently known issues.

NOTE: If you find any bugs in hIDE please report them via email to:
[e-mail]