Skip to content

Commit

Permalink
Updates to INSTALL file.
Browse files Browse the repository at this point in the history
* INSTALL: Rearranged and updated instructions so they make more
sense.
  • Loading branch information
Joseph Corneli committed Jul 25, 2010
1 parent b10b9fc commit cd826d4
Showing 1 changed file with 24 additions and 20 deletions.
44 changes: 24 additions & 20 deletions INSTALL
@@ -1,4 +1,22 @@
* REQUIREMENTS
* OBTAINING RUDEL

Archives of released versions can be downloaded from the download
area of the Sourceforge project page.

http://sourceforge.net/projects/rudel/

Development versions are available via

+ the Bazaar repository on Sourceforge:
bzr branch bzr://rudel.bzr.sourceforge.net/bzrroot/rudel/trunk rudel

+ the SubVersion repository on Sourceforge:
svn co https://rudel.svn.sourceforge.net/svnroot/rudel/trunk rudel

+ the (experimental, but hopefully properly synchronized) Git repository at GitHub:
git clone git://github.com/scymtym/rudel.git

* DEPENDENCIES

Rudel is developed and tested only with GNU Emacs and therefore
unlikely to run on other Emacs variants like XEmacs.
Expand All @@ -11,16 +29,10 @@
but are not actively tested.

** Collection of Emacs Development Environment Tools (CEDET)
Cedet contains the object system Eieio, which is used in Rudel's
object-oriented implementation. Cedet can be obtained from
http://cedet.sourceforge.net/

*IMPORTANT*: It is necessary to use at least the 1.0pre6 version of
CEDET since it fixes a serious problem in the object system Eieio.

As of October 2009, Eieio is included in GNU Emacs. If you are
using a version built since then, you do not have to install it
yourself.
yourself. (Otherwise, CEDET can be obtained from
http://cedet.sourceforge.net/)

** GnuTLS (optional)
Connections to Gobby servers require the gnutls-cli program.
Expand All @@ -40,24 +52,16 @@

* INSTALLING

To install Rudel, download a released version or the current
development version from http://sourceforge.net/projects/rudel/ and
place the code in any directory you like.

Once Eieio (see CEDET in the [[*REQUIREMENTS]] section above) is
installed, add the following to your personal Emacs configuration:
Evaluating [[./rudel-compile.el]] (e.g. find file and invoke M-x
eval-buffer) makes rudel-loaddefs.el and byte compiles all source
files. Then, add the following to your personal Emacs configuration:

(load-file "/PATH/TO/RUDEL/rudel-loaddefs.el")

This will set Rudel up to be loaded on demand when one of the
commands `rudel-join-session', `rudel-host-session' or
`global-rudel-minor-mode' is invoked.

* COMPILING

In order to achieve better performance, Emacs can byte-compile the
Rudel code. This can be done by opening [[./rudel-compile.el]] in Emacs
and invoking M-x eval-buffer.

#+TITLE: Rudel INSTALL Instructions
#+AUTHOR: Jan Moringen
Expand Down

0 comments on commit cd826d4

Please sign in to comment.