mirror of
https://github.com/edeproject/ede.git
synced 2023-08-10 21:13:03 +03:00
Improve readme
This commit is contained in:
parent
5489ef0b70
commit
84f195c9b7
41
README.md
41
README.md
@ -1,55 +1,58 @@
|
|||||||
# EDE
|
# EDE
|
||||||
|
|
||||||
EDE is small and fast desktop environment that uses
|
EDE, the `Equinox Desktop Environment`, is a small and fast desktop
|
||||||
[FLTK toolkit](http://www.fltk.org). For more details and philosophy
|
environment that uses the [FLTK toolkit](http://www.fltk.org).
|
||||||
behind it, check
|
For more details and the philosophy behind it, see
|
||||||
[about EDE on our wiki](http://equinox-project.org/wiki/AboutEde).
|
[about EDE on our wiki](http://equinox-project.org/wiki/AboutEde).
|
||||||
|
|
||||||
## Build requirements
|
## Build requirements
|
||||||
|
|
||||||
EDE is using FLTK toolkit from http://www.fltk.org. At the time of
|
EDE requires FLTK; at the time of this writing, the latest stable
|
||||||
this writing, the latest stable tree is 1.3.x.
|
branch is 1.3.x.
|
||||||
|
|
||||||
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
|
environment, we have developed a small add-on library called
|
||||||
`edelib`. This library is also required for compiling EDE and is
|
`edelib`. This library is needed both for building and running the
|
||||||
released together with EDE.
|
desktop. Edelib is developed and released together with EDE.
|
||||||
|
|
||||||
We *strongly* recommend that you use matching versions of EDE and
|
It is *strongly* recommended to use matching versions of EDE and
|
||||||
edelib (e.g. released at the same time) or you make repository
|
edelib (i.e. versions released at the same time) or to checkout
|
||||||
checkout at the same time due their frequent changes.
|
both from the repository at the same time to make sure they work
|
||||||
|
together well.
|
||||||
|
|
||||||
Also you will need a `jam` tool. Jam is a *make* replacement and you
|
Also you will need the `jam` tool. Jam is a *make* replacement and you
|
||||||
can find it on our repository.
|
can find it on our repository.
|
||||||
|
|
||||||
## Downloading the code
|
## Downloading the code
|
||||||
|
|
||||||
The best way to download latest code is checking it out from our
|
The best way to get the latest code is checking it out from our
|
||||||
repository. These modules you should checkout (with their paths):
|
repository. These are the modules you should checkout (with their paths):
|
||||||
|
|
||||||
- *jam* - `git clone https://github.com/edeproject/jam.git`
|
- *jam* - `git clone https://github.com/edeproject/jam.git`
|
||||||
- *edelib* - `git clone https://github.com/edeproject/edelib.git`
|
- *edelib* - `git clone https://github.com/edeproject/edelib.git`
|
||||||
- *ede* - `git clone https://github.com/edeproject/ede.git`
|
- *ede* - `git clone https://github.com/edeproject/ede.git`
|
||||||
|
|
||||||
If you already have Jam installed, there is no need to download it.
|
If you already have Jam installed, there is of course no need to download
|
||||||
|
it again. Either vanilla Jam or FTJam can be used to build EDE. Boost Jam is
|
||||||
|
known to *not* work.
|
||||||
|
|
||||||
## Compiling and installing
|
## Compiling and installing
|
||||||
|
|
||||||
In order to build and install EDE do the following steps:
|
In order to build and install EDE do the following steps:
|
||||||
|
|
||||||
1. compile and install `jam` first; going to jam source directory and running `make` will do
|
1. compile and install `jam` first; going to jam source directory and running `make` will do
|
||||||
the job; after that you should get `bin.YOUR_PLATFORM` directory (on Linux it will be
|
the job; after that you should get `bin.YOUR_PLATFORM` directory (e.g. on Linux it will be
|
||||||
bin.linux) and copy `jam` executable in your $PATH, e.g. */usr/local/bin*
|
bin.linux) and copy `jam` executable in your $PATH, e.g. */usr/local/bin*
|
||||||
|
|
||||||
2. compile and install `edelib`; please read README file in edelib directory
|
2. compile and install `edelib`; please read README file in edelib directory
|
||||||
|
|
||||||
3. go in ede directory and run `./autogen.sh`
|
3. change into the ede directory and run `./autogen.sh`
|
||||||
|
|
||||||
4. after that, goes `./configure --enable-debug`
|
4. after that, do `./configure --enable-debug`
|
||||||
|
|
||||||
5. jam
|
5. jam
|
||||||
|
|
||||||
6. jam install
|
6. jam install
|
||||||
|
|
||||||
Please note how this document is quick and short tutorial about EDE installation. For more details,
|
Please note that this document is only a quick and short tutorial on installing EDE. For more details
|
||||||
please check [Installation Howto](http://equinox-project.org/wiki/InstallationHowTo) on our wiki.
|
please see [Installation Howto](http://equinox-project.org/wiki/InstallationHowTo) on our wiki.
|
||||||
|
Loading…
Reference in New Issue
Block a user