Skip to content
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
src
COPYING
README
compile-eide.el
install
release_notes.txt

README

/------------------------------------------\
| Emacs-IDE version 1.7+ (2012-01)         |
|                                          |
| Homepage: http://home.gna.org/emacs-ide/ |
\------------------------------------------/

Copyright (C) 2008-2012 Cédric Marie <cedric_marie@gna.org>

This program is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

-------------------------------------------------------------------------------
Contributions
-------------------------------------------------------------------------------

Thanks to all users for their feedback, bug reports, and suggestions.

Contributors:
- Cédric Chépied (git support, local installation)

-------------------------------------------------------------------------------
Description
-------------------------------------------------------------------------------

Emacs-IDE is an Integrated Development Environment (IDE) interface for Emacs
(code browsing, compilation, debug...).

The purpose is to provide a user-friendly interface, with dedicated windows
(source, menu and output) and convenient shortcuts.

It is suitable for almost all languages (as long as they are supported by
Ctags). Cscope provides additional browsing facility for C/C++ files.

-------------------------------------------------------------------------------
Information
-------------------------------------------------------------------------------

Programming language: Emacs Lisp
License: GPLv3
Dependencies: Emacs, Ctags, Cscope.
Supported OS: GNU/Linux.

-------------------------------------------------------------------------------
Installation
-------------------------------------------------------------------------------

You can install Emacs-IDE:
- for all users:
  Execute "./install" (with root privileges) in a terminal.
- for this user only:
  Execute "./install -l" in a terminal.

At the end of installation, instructions are given for enabling Emacs-IDE in
your ~/.emacs.

-------------------------------------------------------------------------------
Instructions
-------------------------------------------------------------------------------

When you launch Emacs, it should look like this:

        -----------------------------------------------------------
        |                                         |               |
        |                                         |               |
        |       "source" window                   | "menu" window |
        |                                         |               |
        |                                         |               |
        |                                         |               |
        |                                         |               |
        |                                         |               |
        |                                         |               |
        |                                         |               |
        |                                         |               |
        -----------------------------------------------------------
        |                                                         |
        |               "output" window                           |
        |                                                         |
        -----------------------------------------------------------

If you click on right button over "source" window, all other windows are
closed. Click again to get them back.

Instructions are available in "Help" page: click on right button over "menu"
window, and select "Help" in popup menu.

-------------------------------------------------------------------------------
Configuration
-------------------------------------------------------------------------------

Default configuration overrides some Emacs settings (including your own
settings in ~/.emacs), in order to take advantage of all user-friendly
features.

If you don't want to override these settings, you can disable "Override Emacs
settings" option in customization: click on right button over "menu" window,
select "Configuration" in popup menu, disable "Override Emacs settings" option,
click on "Save for future sessions", and click on right button to exit
customization.

You can also disable only the settings that you don't want to override (in
"Emacs settings" group).

-------------------------------------------------------------------------------
Quick start
-------------------------------------------------------------------------------

The directory from which Emacs is launched is important: it stands as the root
directory during Emacs session.

If you work on a project - which is the main purpose of Emacs-IDE - you should
always run Emacs from the root directory of your project.

When you first run Emacs for a project, click on right button over "menu"
window, and select "Create project".

-------------------------------------------------------------------------------
Hosting history
-------------------------------------------------------------------------------

2008-04: First publication on Sourceforge: http://emacs-ide.sourceforge.net/
  Initial commit in svn repository.

2010-07: Change of project hosting service: http://home.gna.org/emacs-ide/
  Import all release versions (from 1.0 to 1.3) in svn repository and download
  area.

2010-08: Creation of local git repository
  Create git repository for local work (commit all release versions, from 1.0
  to 1.4). All developments after version 1.4 are commited both in local git
  repository, and svn repository on Gna.
  Git repository should be used as the reference in the future, when git is
  supported on hosting server.
Something went wrong with that request. Please try again.