Skip to content
This repository was archived by the owner on Mar 29, 2024. It is now read-only.

Commit e9cea46

Browse files
committed
Add readme file [skip ci]
1 parent 7bc8758 commit e9cea46

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# php-v8
2+
PHP extension for V8 JavaScript engine
3+
4+
[![Build Status](https://travis-ci.org/pinepain/php-v8.svg)](https://travis-ci.org/pinepain/php-v8)
5+
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/pinepain/php-v8/master/LICENSE)
6+
7+
**This extension is still under heavy development and it public API may change without any warning. Use at your own risk.**
8+
9+
10+
## Developers note
11+
12+
- `export DEV_TESTS=1` allows to run tests that made for development reason (e.g. test some weird behavior or for debugging)
13+
- To prevent asking test suite to send results to PHP QA team do `export NO_INTERACTION=1`
14+
15+
- To track memory usage you may want to use `smem`, `pmem` and even `lsof` to se what shared object are loaded
16+
and `free` to display free and used memory in the system.
17+
18+
19+
## Edge cases:
20+
21+
### Templates recursion:
22+
23+
When you set property on any `Template` (`ObjectTemplate` or `FunctionTemplate`) it shouldn't lead to recursion during
24+
template instantiation while it leads to segfault and for now there are no reasonable way to avoid this on extension
25+
level (probably, some wrapper around `ObjectTemplate` and `FunctionTemplate` will solve this.
26+
27+
Known issues demo:
28+
29+
```php
30+
$isolate = new v8\Isolate();\
31+
32+
$template = new ObjectTemplate($isolate);
33+
34+
$template->Set('self', $template); // leads to segfault
35+
```
36+
37+
## License
38+
39+
Copyright (c) 2015-2016 Bogdan Padalko <[email protected]>
40+
41+
[php-v8](https://github.com/pinepain/php-v8) PHP extension is licensed under the [MIT license](http://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)