Fix build when using system installed lz4 library instead of third-party
[hiphop-php.git] / README.md
blobfcb81467fe3fe340e59efdf95c688f555474725e
1 # HHVM
3 [HHVM page](http://hhvm.com) |
4 [Hacklang page](http://hacklang.org) |
5 [General group](https://www.facebook.com/groups/hhvm.general/) |
6 [Dev group](https://www.facebook.com/groups/hhvm.dev/?ref=br_tf) |
7 [Twitter](http://twitter.com/HipHopVM)
9 HHVM (aka the HipHop Virtual Machine) is an open-source virtual machine designed for executing programs written in [Hack](http://hacklang.org) and PHP. HHVM uses a just-in-time compilation approach to achieve superior performance while maintaining the flexibility that PHP developers are accustomed to. To date, HHVM (and its predecessor HPHPc before it) has realized over a 9x increase in web request throughput and over a 5x reduction in memory consumption for Facebook compared with the PHP 5.2 engine + APC.
11 HHVM should be used together with a FastCGI-based webserver like [nginx](https://github.com/facebook/hhvm/wiki/FastCGI#making-it-work-with-nginx) or [apache](https://github.com/facebook/hhvm/wiki/FastCGI#making-it-work-with-apache).
14 ## FAQ
16 Our [FAQ](https://github.com/facebook/hhvm/wiki/FAQ) has answers to many common questions about HHVM, from [general questions](https://github.com/facebook/hhvm/wiki/FAQ#general) to questions geared towards those that want to [use](https://github.com/facebook/hhvm/wiki/FAQ#users) or [contribute](https://github.com/facebook/hhvm/wiki/FAQ#contributors) to HHVM.
19 ## Installing
21 You can install a [prebuilt package](https://github.com/facebook/hhvm/wiki/Prebuilt%20Packages%20for%20HHVM) or [compile from source](https://github.com/facebook/hhvm/wiki/Building%20and%20Installing%20HHVM).
24 ## Running
26 You can run standalone programs just by passing them to hhvm: `hhvm my_script.php`.
28 If you want to host a website:
29 * Install your favorite webserver
30 * Install our [package](https://github.com/facebook/hhvm/wiki/Prebuilt%20Packages%20for%20HHVM)
31 * Start your webserver
32 * Run `sudo /etc/init.d/hhvm start`
33 * Visit your site at http://.../index.php
36 ## Contributing
38 We'd love to have your help in making HHVM better. If you're interested, please read our [guide to contributing](CONTRIBUTING.md).
40 ## License
42 HHVM is licensed under the PHP and Zend licenses except as otherwise noted.
44 The Hack typechecker (`hphp/hack`) is licensed under the BSD license (`hphp/hack/LICENSE`) with an additional grant of patent rights (`hphp/hack/PATENTS`) except as otherwise noted.
47 ## Reporting Crashes
49 See [Reporting Crashes](https://github.com/facebook/hhvm/wiki/Reporting-Crashes) for helpful tips on how to report crashes in an actionable manner.