README 4.01 KB
Newer Older
1 2 3 4 5
***********
Description
***********

cerbero is a multi-platform build system for Open Source projects that builds
6
and creates native packages for different platforms, architectures and distributions.
7 8 9 10 11 12 13 14 15 16 17

Projects are defined using recipes files (.recipe), which provides a description
of the project being built such as name, version, licenses, sources and the way
it's built. It also provide listing of files, which is later used for the packaging.

Packages are defined using packages files (.package), describing the package name,
version, license, maintainer and other fields used to create the packages. A
package wraps a list of recipes, from which the list of files belonging to the
package will be extracted.


Andoni Morales Alastruey's avatar
Andoni Morales Alastruey committed
18
********************
19
Minimum Requirements
Andoni Morales Alastruey's avatar
Andoni Morales Alastruey committed
20
********************
21 22 23 24 25 26

cerbero provides bootstrapping facilities for all platforms, but it still needs a
minimum base to bootstrap

Linux
-----
27
On Linux, you will only need a distribution with python 2.7.
28 29 30

OSX
---
31 32
On OSX you will need to have install the following software:
  * XCode
33 34 35

Windows
-------
36
The initial setup on Windows is a little bit longer, but only a few programs are required.
37 38 39 40 41 42 43
  * Python2.7: https://www.python.org/downloads/
     IMPORTANT : Chose the 2.7 version. The 3.x versions are *not* supported
  * CMake: http://www.cmake.org/cmake/resources/software.html
  * Git: http://git-scm.com/download/win
     IMPORTANT: Select the install option "Checkout as-is, Commit as-is"
  * Msys/MinGW: http://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download
     Install it with all the options enabled
44
  * WiX 3.5: http://wix.codeplex.com/releases/view/60102
45

46 47
The Direct Show plugins still needs to be built using Microsoft's compiler and their SDK,
due to the dependency on the Direct Show base classes.
48
You need to install the following software:
49
  * Microsoft SDK 7.1: http://www.microsoft.com/en-us/download/details.aspx?id=8279
50 51
  * Windows Driver Kit 7.1.0: http://msdn.microsoft.com/en-us/windows/hardware/hh852365

52 53 54 55
cerbero must be run in the MingGW shell, which is accessible from the main menu or desktop 
(if it is not, go to Mingw Installation manager, select MSYS Base Development and install
msys-bash  lnk).

56
The last step is making python and git available from the shell, for which you will need
57
to create a .profile file:
58

59 60 61 62 63
If you use 64-bit Windows, please execute:

echo 'export PATH="$PATH:/c/Python27:/c/Program Files (x86)/Git/bin:/c/MinGW/bin/"' > ~/.profile

If you use 32-bit Windows, please execute:
64

65 66 67
echo 'export PATH="$PATH:/c/Python27:/c/Program Files/Git/bin:/c/MinGW/bin/"' > ~/.profile

Note that inside the shell, / is mapped to c:\Mingw\msys\1.0\
68 69 70 71 72

*****
Usage
*****

73 74 75 76 77 78 79
Despite the presence of setup.py this tool does not need installation. It is invoked via the
cerbero-uninstalled script, which should be invoked as ./cerbero-uninstalled, or you can add 
the cerbero directory in your path and invoke it as cerbero-uninstalled.

The examples below assume the tool is in your PATH; if not, just remember to use ./cerbero-uninstalled
instead of cerbero-uninstalled.

80 81
Bootstrap
---------
Andoni Morales Alastruey's avatar
Andoni Morales Alastruey committed
82
Before using cerbero for the first time, you will need to run the bootstrap command.
83
This command installs the missing parts of the build system using the packages manager
84 85
when available. Note that this will take a while (a couple hours or even more).
  $ cerbero-uninstalled bootstrap
86 87 88

Help
----
89
  $ cerbero-uninstalled --help
90 91 92

List available recipes
----------------------
93
  $ cerbero-uninstalled list
94 95 96

List available packages
-----------------------
97
  $ cerbero-uninstalled list-packages
98 99 100

Build a recipe
--------------
101
  $ cerbero-uninstalled build gtk+
102 103 104

Rebuild a single recipe
-----------------------
105
  $ cerbero-uninstalled buildone gtk+
106 107 108

Clean a recipe
--------------
109
  $ cerbero-uninstalled cleanone gtk+
110

111
Create a package (this automatically invokes build)
112
----------------
113
  $ cerbero-uninstalled package gstreamer-1.0
114 115 116


*******
Andoni Morales Alastruey's avatar
Andoni Morales Alastruey committed
117
License
118 119 120 121 122 123 124 125 126
*******

cerbero is released under the GNU Lesser General Public License, Version 2.1 (LGPLv2.1)


************
Dependencies
************

127
 * python 2.7