ede/README.alpha

122 lines
3.9 KiB
Plaintext
Raw Normal View History

2006-08-23 14:59:00 +04:00
README for EDE 2.0 pre-alpha
============================
($Id$)
Please read this document before using or contributing to EDE 2.0 source code
before or during 2.0alpha release.
2007-03-17 14:28:25 +03:00
Build requirements
------------------
2006-08-23 14:59:00 +04:00
EDE 2.0 is using fltk1 toolkit from www.fltk.org. At the time of this writing,
last released version was 1.1.7 and 1.1.8 was coming really soon. We
recommend using the latest daily snapshot - they are extremely stable and
that's what we use internally - although 1.1.7 should work too.
Nevertheless, we will (soon) keep our own "fork" called fltk-copy which is
basically the last SVN snapshot of fltk that EDE is known to work with. If
there are any patches required for proper EDE functioning, you should find
them in fltk-copy/patches/ tree. Further instructions will be in
fltk-copy/README.EDE
Since fltk lacks many things needed for developing a full *nix desktop
environment, we have developed a small add-on library called edelib. This
library is also required for compiling EDE2. It should be released together
with EDE. We *strongly* recommend that you use matching versions of ede and
edelib (e.g. released at the same time) or that you do SVN checkout at the
same time.
2006-08-23 14:59:00 +04:00
2007-03-17 14:28:25 +03:00
Make sure you have efltk installed, because some packages still requires it.
2006-08-23 14:59:00 +04:00
Also you will need Jam utility. Jam is a make replacement and removes a lot
of its limitations. Current EDE source can be built either via jam or make,
but note that make builds will be soon removed.
2007-03-17 14:28:25 +03:00
Jam can be downloaded from our repository.
Compiling
---------
2006-08-23 14:59:00 +04:00
At the moment, certain modules in EDE do not compile! In order to build and install
EDE do the following steps:
2006-08-23 14:59:00 +04:00
1. ./prepare
2. ./configure [OPTIONS] (we suggest using --enable-debug)
2006-08-23 14:59:00 +04:00
3. (old method, soon will be removed)
Go into directories of individual modules and compile them. Type
2006-08-23 14:59:00 +04:00
cd $MODULE; make; make install; cd ..
Since developers don't use make anymore, this method could get broken
occasionally.
3. (new method, default)
2007-03-17 14:28:25 +03:00
jam
"jam install" is not finished yet. You can use various programs from
their work directories, or copy them into e.g. /usr/bin
2007-03-17 14:28:25 +03:00
2006-08-23 14:59:00 +04:00
Stuff that isn't updated (requires efltk)
-----------------------------------------
2006-08-23 14:59:00 +04:00
- edewm
- eworkpanel
We are in the process of rewriting these modules from scratch. Please use edewm
and eworkpanel from EDE 1.x (it should work without major problems).
2006-08-23 14:59:00 +04:00
- efinder
It will be ported to fltk1 as soon as we finish efiler (see below) cause we
2006-08-23 14:59:00 +04:00
would like to use same widgets for displaying file list.
- emenueditor
It will either be completely rewritten or removed, because EDE 2 will use XDG menus
(FreeDesktop.org).
- e*conf
Many of the control center applets will be dropped or replaced with something
else. epanelconf obviously depends on eworkpanel which is not yet finished.
2006-08-23 14:59:00 +04:00
2007-03-17 14:28:25 +03:00
New modules in EDE 2.0
----------------------
2006-08-23 14:59:00 +04:00
- edialog
Command line utility for displaying dialogs (useful for scripting). It is very
UNFINISHED.
- efiler
Simple and lightweight file manager. Currently it's fully functional, but we
plan some more features.
2006-08-23 14:59:00 +04:00
- eimage
Small image viewer. Likewise, functional but a few features will be added.
- ecalc
Scientific calculator.
2006-08-23 14:59:00 +04:00
2007-03-17 14:28:25 +03:00
Contributors wanted
-------------------
2006-08-23 14:59:00 +04:00
We would very appreciate help from contributors willing to take any of following
tasks:
- Port efinder to fltk/edelib and become its maintainer
2006-08-23 14:59:00 +04:00
- Write new enotepad using editor from fltk/test (I believe this is easier than
porting old enotepad from efltk to fltk) and become its maintainer
2006-08-23 14:59:00 +04:00
- Propose new designs for econtrol and eworkpanel (that are realistic to implement
with fltk, ofcourse :)
- Find any old ede application, port to fltk/edelib and become its maintainer
- Find useful fltk apps on www.fltk.org and see if they can be ede-ified
2006-08-23 14:59:00 +04:00
Also, EDE code is sparkled with comments starting with TODO and FIXME -
please see what of that you can do (just type e.g. "grep TODO . -R"). EDE
coding standards and EDE HIG documents are being prepared.