@@ -17,6 +17,28 @@ Boson brings together a set of components, each handling a key part of the syste
1717Together, they create a seamless environment for building rich desktop applications with
1818web technologies — without the bloat.
1919
20+
21+ ## Runtime
22+
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:
26+
27+ ``` shell
28+ composer require boson-php/runtime
29+ ```
30+
31+ Don't forget to include the autoload file in your application.
32+
33+ ``` php
34+ <?php
35+
36+ require __DIR__ . '/vendor/autoload.php';
37+
38+ $app = new Boson\Application();
39+ ```
40+
41+
2042## Requirements
2143
2244<tabs >
@@ -150,4 +172,81 @@ web technologies — without the bloat.
150172<warning >
151173Please note that the application build is not currently available,
152174so production dependencies may differ in the future.
153- </warning >
175+ </warning >
176+
177+
178+ ## Troubleshooting
179+
180+ ### An [ ext-ffi] disabled in your php.ini
181+
182+ ``` shell
183+ FFI\E nv\E xception\E nvironmentException: An [ext-ffi] disabled in your php.ini
184+ ```
185+
186+ <note >
187+ Make sure that the <code >ffi.enable</code > config in your <code >php.ini</code >
188+ file is set to <code >preload</code > (by default) or <code >true</code >.
189+
190+ <compare >
191+ <code-block lang =" ini " >
192+ ffi.enable=false
193+ </code-block >
194+ <code-block lang =" ini " >
195+ ffi.enable=preload
196+ </code-block >
197+ </compare >
198+ </note >
199+
200+ ### An [ ext-ffi] not available
201+
202+ ``` shell
203+ FFI\E nv\E xception\E nvironmentException: An [ext-ffi] not available
204+ ```
205+
206+ <note >
207+ Make sure that FFI extension is installed.
208+
209+ <tabs >
210+ <tab title =" Windows " >
211+ <list >
212+ <li>
213+ Open your <code>php.ini</code> file.
214+ <tip>The location of the configuration file can be found using the <code>php --ini</code> console command</tip>
215+ </li>
216+ <li>
217+ Find <code>extension=ffi</code> line and uncomment extension.
218+ <compare>
219+ <code-block lang="ini">
220+ ;extension=ffi
221+ </code-block>
222+ <code-block lang="ini">
223+ extension=ffi
224+ </code-block>
225+ </compare>
226+ </li>
227+ </list >
228+ </tab >
229+ <tab title =" Linux (Debian) " >
230+ <code-block lang =" bash " >
231+ sudo apt update
232+ sudo apt install php8.4-ffi
233+ </code-block >
234+ </tab >
235+ </tabs >
236+ </note >
237+
238+
239+ ### [ Linux] Failed loading '.../libboson-linux-xxx.so'
240+
241+ <note >
242+ Make sure that GTK4 is installed.
243+ <tabs >
244+ <tab title =" Linux (Debian) " >
245+ <code-block lang =" bash " >
246+ sudo apt update
247+ sudo apt install libwebkitgtk-6.0-4
248+ </code-block >
249+ </tab >
250+ </tabs >
251+ </note >
252+
0 commit comments