Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 99 lines (62 sloc) 2.437 kb
aa680af Make process improvements.
mihai.sucan authored
1 Copyright (C) 2008, 2009 Mihai Şucan
e5b8093 --HG--
mihai.sucan authored
2
3 $URL: http://code.google.com/p/paintweb $
aa680af Make process improvements.
mihai.sucan authored
4 $Date: 2009-10-10 20:33:25 +0300 $
e5b8093 --HG--
mihai.sucan authored
5
6
3468671 updated README and INSTALL
mihai.sucan authored
7 You don't need to install this Web application. Just open a demo from the demos
8 folder in your Web browser. For documentation please check the API reference and
9 the wiki pages published at http://code.google.com/p/paintweb.
e5b8093 --HG--
mihai.sucan authored
10
aa680af Make process improvements.
mihai.sucan authored
11 Repackaging PaintWeb
12 ====================
13
14 Important folders:
15
16 - src/ - holds the source code spread across multiple files.
17 - build/ - holds the packaged build.
18 - scripts/ - holds scripts used for packaging.
19
20 If you make changes to files in the src/ folder you may want to repackage
21 PaintWeb - regenerate the build folder.
22
23 Prerequisites
24 -------------
25
26 - PHP 5+
27
28 - Makefile support. Usually, you get this really easily and quickly on any
29 Linux distribution. Tested with Ubuntu.
30
31 - Java VM.
32
33 - YUI Compressor. This is used for compressing JavaScript and CSS files. Get
34 it from:
35
36 http://developer.yahoo.com/yui/compressor/
37
38 - jsdoc-toolkit. This is used for generating the API reference documentation
39 based on the source code. Get it from:
40
41 http://jsdoctoolkit.org/
42
43 Make sure you unpack jsdoc-toolkit and yuicompressor and you have both scripts
44 working fine with your Java VM.
45
46 Run the following command in your PaintWeb folder:
47 make config
48
49 Now you have config-local.mk. Open it and make sure:
50
51 - BIN_PHP points to your PHP binary.
52 - FOLDER_YUIC points to your YUI Compressor unpacked folder.
53 - FOLDER_JSDOCT points to your jsdoc-toolkit unpacked folder.
54
55 Now you are ready!
56
57
58 Run make
59 --------
60
61 To generate the build folder run:
62 make
63
64 You will have build/paintweb.src.js for debugging purposes.
65
66 To generate the API reference documentation run:
67 make docs
68
69 To get an archived PaintWeb package as a release simply run:
70 make release
71
72 That will give you a file like paintweb-0.9.tar.bz2. The version number is
73 determined automatically.
74
75 You can also make a snapshot of PaintWeb:
76 make snapshot
77
78 Snapshots have the build date included. For example
79 paintweb-0.9-20091010.tar.bz2.
80
81 If you want to make a custom build of PaintWeb for Moodle 1.9 or Moodle 2.0 then
82 run:
83 make moodle19
84 or
85 make moodle20
86
87 This will make sure that the Moodle extension for PaintWeb is included in the
88 package.
89
90 To generate a tags file from the PaintWeb source code run:
91 make tags
92
93 That's about all. Enjoy!
94
95
e5b8093 --HG--
mihai.sucan authored
96 --
97 vim:set spell spl=en fenc=utf-8 ff=unix:
98
Something went wrong with that request. Please try again.