Some docs enhacements.

Let README content be shown on the start page
This commit is contained in:
Sanel Zukan 2009-01-14 13:15:44 +00:00
parent 90d616cfb1
commit 50288aab5f
3 changed files with 56 additions and 61 deletions

View File

@ -11,6 +11,7 @@
SubDir TOP ; SubDir TOP ;
EdeManual HACKING ; EdeManual HACKING ;
EdeManual README.alpha ;
Clean distclean : $(JCACHEFILE) $(HCACHEFILE) ; Clean distclean : $(JCACHEFILE) $(HCACHEFILE) ;

View File

@ -1,75 +1,81 @@
README for EDE 2.0 pre-alpha Readme for EDE 2.0
============================ ==================
($Id$)
Please read this document before using or contributing to EDE 2.0 source code Please read this document before using or contributing to EDE 2.0 source code
before or during 2.0alpha release. before 2.0 release.
[NOTE]
.This is alpha product
===================================
EDE 2.0 is not finished yet and many components are not completed,
can crash or misbehave
===================================
Build requirements Build requirements
------------------ ------------------
EDE 2.0 is using fltk1 toolkit from www.fltk.org. At the time of this writing, EDE 2.0 is using FLTK toolkit from http://www.fltk.org[www.fltk.org]. At the time
last released version was 1.1.7 and 1.1.8 was coming really soon. We 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 recommend using the latest daily snapshot - they are extremely stable and
that's what we use internally - although 1.1.7 should work too. 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 Since fltk lacks many things needed for developing a full *nix desktop
environment, we have developed a small add-on library called edelib. This environment, we have developed a small add-on library called 'edelib'. This
library is also required for compiling EDE2. It should be released together library is also required for compiling EDE 2.0 and should be released together
with EDE. We *strongly* recommend that you use matching versions of ede and 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 edelib (e.g. released at the same time) or that you do SVN checkout at the
same time. same time.
Make sure you have efltk installed, because some packages still requires it. Make sure you have eFLTK installed too, because some packages still requires it.
Also you will need Jam utility. Jam is a make replacement and removes a lot Also you will need a Jam tool. Jam is a make replacement and removes a lot
of its limitations. Current EDE source can be built either via jam or make, of its limitations and you can find it on our repository.
but note that make builds will be soon removed.
Jam can be downloaded from our repository. Downloading the code
--------------------
The best way to download latest code is checking it out from our repository. Make sure
you checkout jam (if you already don't have it installed), edelib, ede2 and efltk modules.
Here are the commands:
- jam : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/jam'
- edelib : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/edelib'
- ede : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/ede2'
- efltk : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/efltk'
Compiling Compiling
--------- ---------
At the moment, certain modules in EDE do not compile! In order to build and install In order to build and install EDE do the following steps:
EDE do the following steps:
1. ./autogen.sh 1. compile and install jam first; going to jam source directory and runnig 'make' will do
the job; after that you should get 'bin.YOUR_PLATFORM' directory (on linux it will be
bin.linux) and copy 'jam' executable in your $PATH, e.g. /usr/local/bin
2. ./configure [OPTIONS] (we suggest using --enable-debug) 2. compile and install edelib; please read README file in edelib directory
3. (old method, soon will be removed) 3. compile and install efltk; './configure --disable-mysql --disable-unixODBC && make && make install'
will do the job
Go into directories of individual modules and compile them. Type
cd $MODULE; make; make install; cd ..
Since developers don't use make anymore, this method could get broken 4. then go in ede2 directory and run './autogen.sh'
occasionally.
3. (new method, default) 5. after that, goes './configure --enable-debug'
jam 6. jam
"jam install" is not finished yet. You can use various programs from 7. jam install
their work directories, or copy them into e.g. /usr/bin
Important stuff that isn't updated (requires efltk)
Stuff that isn't updated (requires efltk) ---------------------------------------------------
-----------------------------------------
- edewm - edewm
- eworkpanel - 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). We are in the process of rewriting these modules from scratch so older versions
will be provided
- efinder - efinder
It will be ported to fltk1 as soon as we finish efiler (see below) cause we It will be ported to fltk1 as soon as we finish efiler (see below) cause we
@ -79,11 +85,6 @@ would like to use same widgets for displaying file list.
It will either be completely rewritten or removed, because EDE 2 will use XDG menus It will either be completely rewritten or removed, because EDE 2 will use XDG menus
(FreeDesktop.org). (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.
New modules in EDE 2.0 New modules in EDE 2.0
---------------------- ----------------------
@ -98,24 +99,16 @@ plan some more features.
- eimage - eimage
Small image viewer. Likewise, functional but a few features will be added. Small image viewer. Likewise, functional but a few features will be added.
- ecalc - ede-calc
Scientific calculator. Scientific calculator.
TODO: to be filled
Contributors wanted Contributors wanted
------------------- -------------------
We would very appreciate help from contributors willing to take any of following As usualy, every help is very appreciated :)
tasks:
- Port efinder to fltk/edelib and become its maintainer
- 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
- 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
Also, EDE code is sparkled with comments starting with TODO and FIXME - 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 please see what of that you can do (just type e.g. "grep TODO . -R" or "grep FIXME . -R").
coding standards and EDE HIG documents are being prepared. EDE coding standards and EDE HIG documents are being prepared.

View File

@ -17,11 +17,12 @@
=================== ===================
:Revision: 0.1 :Revision: 0.1
*Bare info* Introduction
- link:README.html[Readme First]
- link:introduction.html[Introduction] - link:introduction.html[Introduction]
*Programs* Programs
- link:ede-calc.html[ede-calc] - link:ede-calc.html[ede-calc]
- link:ede-help.html[ede-help] - link:ede-help.html[ede-help]
@ -29,7 +30,7 @@
- link:evoke.html[Evoke] - link:evoke.html[Evoke]
- link:emountd.html[Emountd] - link:emountd.html[Emountd]
*Development* Development
- link:HACKING.html[Contributing (in your spare time ;-)] - link:HACKING.html[Contributing (in your spare time ;-)]
- link:jambuild.html[Jam build] - link:jambuild.html[Jam build]