-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
44 lines (29 loc) · 1.44 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
41
42
43
44
phuild is a tool to help distribute PHP scripts along with necessary components.
INTRODUCTION
phuild is a small build system that compiles a script and its dependencies into
a single file. To do so, it parses a phuild.yml which is supposed to reside
in the project root directory as well as a script and its libraries as defined
in phuild.yml. It will then determine which classes and interfaces are used
within a script and build the entire hierarchy of dependencies by looking into
file after file. At the end, a single file will be created which contains all
libraries as well as the original script.
USAGE
./phuild.php /your/project/directory/
You need to add a code block within your script:
#Include
#/Include
The lines in between #Include and #/Include will be replaced by phuild's output.
PARAMETERS
--check prints output on which classses are available or not, without
creating a script.
CONFIGURATION
phuild is configured via a yaml file, phuild.yml. Several entries can be made
to compile more than one script.
Parameters for one entry:
name: A human readable name for an entry
source: source script (relative to project root)
target: target file (relative to project root)
includes: list of include directories to look for dependencies.
Please note that, when using includes, newer entries overwrite older ones. It is
advisable to use Composer's vendor directory first and then your local
dependencies.