44
55Boson brings together a set of components, each handling a key part of the system:
66
7- - [ ** Runtime** ] ( https://github.com/BosonPHP/Runtime ) — acts as the bridge between your PHP code
8- and the underlying operating system. This is the main API that you can use both in runtime and
9- during development.
7+ - [ ** Runtime** ] ( https://github.com/boson-php/runtime ) — acts as the bridge
8+ between your PHP code and the underlying operating system. This is the main
9+ API that you can use both in runtime and during development.
1010
11- - [ ** Frontend ** ] ( https://github.com/BosonPHP/Frontend ) – written in C/C++, it offers a cross-platform
12- low-level API (ABI) to interact with the graphics subsystem .
11+ - [ ** Compiler ** ] ( https://github.com/boson-php/compileer ) – allows you to build
12+ the results of your work into a finished project ready for distribution .
1313
14- - <tooltip term =" TODO " >** Backend** – powers the execution of your PHP code, making sure everything
15- runs smoothly behind the scenes.</tooltip >
14+ <note >
15+ Technically there are more repositories and components, but the main ones
16+ are presented here.
17+ </note >
1618
17- Together, they create a seamless environment for building rich desktop applications with
18- web technologies — without the bloat.
19+ Together, they create a seamless environment for building rich desktop
20+ applications with web technologies — without the bloat.
1921
2022
2123## Runtime
2224
23- Boson runtime library is available as [ Composer] ( https://getcomposer.org/doc/ )
24- repository and can be installed using the following command in a root of your
25- project:
25+ Boson runtime provides the core of the library and allows you to
26+ run your wonderful applications.
27+
28+ Library is available as [ Composer] ( https://getcomposer.org/doc/ ) repository and
29+ can be installed using the following command in a root of your project:
2630
2731``` shell
2832composer require boson-php/runtime
2933```
3034
35+ <warning >
36+ Since the current release version of the package is <code >0.x</code >, you
37+ should make sure that your <code >composer.json</code > file contains the
38+ <code >"minimum-stability": "dev"</code > line, otherwise you will get an
39+ error message like:
40+ <code-block >
41+ Could not find a version of package boson-php/runtime matching your
42+ minimum-stability (stable). Require it with an explicit version con
43+ straint allowing its desired stability.
44+ </code-block >
45+ </warning >
46+
3147Don't forget to include the autoload file in your application.
3248
3349``` php
@@ -39,6 +55,27 @@ $app = new Boson\Application();
3955```
4056
4157
58+ ## Compiler
59+
60+ Boson compiler gives you the ability to assemble the result of your work into
61+ a final product. That is, into an executable file for the target platform.
62+
63+ Library is available as [ Composer] ( https://getcomposer.org/doc/ ) repository and
64+ can be installed using the following command in a root of your project:
65+
66+ ``` shell
67+ composer require boson-php/compiler --dev
68+ ```
69+
70+ <note >
71+ The compiler is only required for development, it is not required for code
72+ execution, so it is recommended to include it as a <code >--dev</code > package.
73+ </note >
74+
75+ <warning >
76+ Make sure the <code >"minimum-stability"</code > is set correctly.
77+ </warning >
78+
4279## Requirements
4380
4481<tabs >
0 commit comments