README 1.18 KB
Newer Older
Steve Kemp's avatar
Added  
Steve Kemp committed
1
2
3
README
------

4
This README is intentionally brief.
Steve Kemp's avatar
Added  
Steve Kemp committed
5

6
All the details on the Bytemark Symbiosis packages may be found online:
Steve Kemp's avatar
Added  
Steve Kemp committed
7

8
  http://symbiosis.bytemark.co.uk/
Steve Kemp's avatar
Added  
Steve Kemp committed
9
10
11
12

Building The Packages
---------------------

Igor Vuk's avatar
Igor Vuk committed
13
The minimum packages needed to get the build process working are:
14

Paul Cammish's avatar
Paul Cammish committed
15
  rake devscripts rdoc graphviz ruby-dev
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

You should be able to build all packages via :

  rake repo

This will generate all files and copy them to a subdirectory of
'repo/'.  Each package has its own dependency requirements and the
build will fail if these are not met.

Using schroot/sbuild/sautobild
------------------------------

It is possible to build the packages using per-arch/distro chroots.
Bytemark have written a package called "sautobuild" which can perform
automated builds of a source package, given a set of schroots.

Other rake tasks
----------------

There are other rake tasks that can be seen by running 

  rake -T

API Documentation
-----------------
Steve Kemp's avatar
Added  
Steve Kemp committed
41

42
43
44
There is plenty of documentation in the Ruby libraries written for
Symbiosis.  Rdoc is used to generate it as part of the
symbiosis-api-doc package.  If you run
Steve Kemp's avatar
Added  
Steve Kemp committed
45

46
  rake rdoc
Steve Kemp's avatar
Added  
Steve Kemp committed
47

48
This will generate it in doc/html.
Steve Kemp's avatar
Added  
Steve Kemp committed
49

50
 -- Patrick J Cherry <patrick@bytemark.co.uk>
Steve Kemp's avatar
Added  
Steve Kemp committed
51