cmollekopf/emerge


Language: Python


This is the readme for the emerge scripts to build kde on windows.

contents:
1. step-by-step guide
2. emerge options
3. the environment and the directory layout
4. remarks to the step-by-step guide
5. Authors, Contact and License

1. step-by-step guide
    - Get Python >= 2.7 ( e.g. from http://www.python.org ).
    - If you can read this file you probably already got the svn-sources.
      If not, get an svn client, preferrably TortoiseSVN ( from 
      http://tortoisesvn.net/downloads ).
    - If you have not done already: make up a directory kderoot somewhere;
      We will refer to it as %KDEROOT% or just kderoot - the name is not
      important at all though.
    - Put another directory emerge into %KDEROOT% enter that directory
      and checkout from svn://anonsvn.kde.org/home/trunk/kdesupport/emerge .
    - Add another directory etc to %KDEROOT%. Copy the file 
      kdesettings-example.bat from the emerge directory into the etc 
      directory. Rename kdesettings-example.bat to kdesettings.bat and edit it
      according to your needs.
    - open up kdeenv.bat from the emerge directory, try 'emerge -p kdebase-runtime'
      and if there are no errors, you can use emerge.

2. running emerge
Call "emerge --help" to get the current documentation
how to call emerge, its recognized commands and options.
(Alternatively open emerge.py in your text editor to read the same text.)

3. the environment and the directory layout
For running emerge in a preset environment, please use the kdeenv.bat. this
will set all Environment variables for you that are needed to build KDE4.
Please be aware that cygwin shouldn't be in your path.
KDE on windows uses a special layout that might change in future releases.
Below %KDEROOT% you will find common unix folders such as bin, lib and etc.
There are some special folders that have another meaning though:
\emerge     This folder contains the portage directory, the emerge scripts
            within the folder bin, this README and the kdesettings-example.bat
\tmp        This folder contains the build directories of all packages.
            After finishing with emerge, you can empty this folder.
\etc        this folder contains lots of settings.
\bin        Contains all executables and all shared libraries.
\lib        Contains all non-shared libraries.
\include    Contains header files.
\share      Contains lots of additional stuff: Wallpapers,mimetype definitions
            and some more.
\mingw      This folder only exists if you install mingw or gdb with emerge.
            The kdeenv.bat will include this folder into the path for you.
            You can of course use this compiler outside of KDE as well.

4. remarks to the step-by-step guide

Python should be within your path ( which is normally set automatically ).
You don't have to register python with the file ending .py though the author
of these lines finds it useful.


    - If you can read this file you probably already got the git sources.
      If not, get an git client, preferrably TortoiseGit ( from 
        http://code.google.com/p/tortoisegit ).

TortoiseGit is an extension to the Windows Explorer and a full featured git
client. It makes development easy. The point in not using a commandline client
is that emerge will not check for an installed commandline client yet.


    - If you have not done already: make up a directory kderoot somewhere;
      We will refer to it as %KDEROOT% or just kderoot - the name is not
      important at all though.

As already stated the name isn't really important. Currently all KDE files
will be installed under KDEROOT, but this might change in the future. 


    - Put another directory emerge into %KDEROOT% enter that directory
      and clone from git://anongit.kde.org/emerge .
      
If you want to directly work on emerge itself, please clone from git@git.kde.org:emerge 
instead.

      
    - Add another directory etc to %KDEROOT%. Copy the file 
      kdesettings-example.bat from the emerge directory into the etc 
      directory. Rename kdesettings-example.bat to kdesettings.bat and edit it
      according to your needs.
      
The file kdesettings-example.bat should contain all necessary informations.
You should read at that point.


    - open up kdeenv.bat from the emerge directory, try 'emerge -p kdebase'
      and if there are no errors, you can use emerge.

You will get a list of packages that emerge would try to build.
You can most of the time ignore warning messages - they are mostly for your
information.

5. Authors, Contact and License
There were multiple authors working on these scripts:
Holger Schröder
Patrick Spendrin
Christian Ehrlicher
Jaroslaw Staniek
Shane King
Bernhard Reiter
Ralf Habacker

You can contact us via our mailing list kde-windows@kde.org

License: the file portage_versions.py can be used
under GPLv2 all other files are licensed (if needed) under BSD

Project Statistics

Sourcerank 3
Repository Size 16.5 MB
Stars 0
Forks 0
Watchers 1
Open issues 0
Dependencies 0
Contributors 45
Tags 0
Created
Last updated
Last pushed

Top Contributors See all

Patrick Spendrin rhabacker Andre Heinecke Hannah von Reth chehrlic aholza wrohdewald Nico Kruber Allen Winter andriusribas Christian Mollekopf Brandhor Ananta Palani Cristian Oneț Thomas McGuire Pau Garcia i Quiles Casper van Donderen staniek Bernhard E. Reiter Laszlo Papp

Something wrong with this page? Make a suggestion

Last synced: 2017-12-25 19:45:27 UTC

Login to resync this repository