Updating submodules
[hiphop-php.git] / README.md
blob996d5ae6400b023e350b3f236b754f27c6d36e38
1 # HHVM
3 [HHVM page](https://hhvm.com) |
4 [HHVM documentation](https://docs.hhvm.com/hhvm/) |
5 [Hacklang page](http://hacklang.org) |
6 [General group](https://www.facebook.com/groups/hhvm.general/) |
7 [Dev group](https://www.facebook.com/groups/hhvm.dev/) |
8 [Twitter](https://twitter.com/HipHopVM)
10 HHVM is an open-source virtual machine designed for executing programs written in [Hack](http://hacklang.org). HHVM uses a just-in-time (JIT) compilation approach to achieve superior performance while maintaining amazing development flexibility.
12 HHVM should be used together with a webserver like the built in, easy to deploy [Proxygen](https://docs.hhvm.com/hhvm/basic-usage/proxygen), or a [FastCGI](https://docs.hhvm.com/hhvm/advanced-usage/fastCGI)-based webserver on top of nginx or Apache.
14 ## Installing
16 If you're new, try our [getting started guide](https://docs.hhvm.com/hhvm/getting-started/getting-started).
18 You can install a [prebuilt package](https://docs.hhvm.com/hhvm/installation/introduction#prebuilt-packages) or [compile from source](https://docs.hhvm.com/hhvm/installation/building-from-source).
20 ## Running
22 You can run standalone programs just by passing them to hhvm: `hhvm example.hack`.
24 If you want to host a website:
25 * Install your favorite webserver. [Proxygen](https://docs.hhvm.com/hhvm/basic-usage/proxygen) is built into HHVM, fast and easy to deploy.
26 * Install our [package](https://docs.hhvm.com/hhvm/installation/introduction#prebuilt-packages)
27 * Start your webserver
28 * Run `sudo /etc/init.d/hhvm start`
29 * Visit your site at `http://.../main.hack`
31 Our [getting started guide](https://docs.hhvm.com/hhvm/getting-started/getting-started) provides a slightly more detailed introduction as well as links to more information.
33 ## Contributing
35 We'd love to have your help in making HHVM better. If you're interested, please read our [guide to contributing](CONTRIBUTING.md).
37 ## License
39 HHVM is licensed under the PHP and Zend licenses except as otherwise noted.
41 The [Hack typechecker](hphp/hack) is licensed under the MIT [License](hphp/hack/LICENSE) except as otherwise noted.
43 The [Hack Standard Library](hphp/hsl) is licensed under the MIT [License](hphp/hsl/LICENSE) except as otherwise noted.
45 ## Reporting Crashes
47 See [Reporting Crashes](https://github.com/facebook/hhvm/wiki/Reporting-Crashes) for helpful tips on how to report crashes in an actionable manner.
49 ## Security
51 For information on reporting security vulnerabilities in HHVM, see [SECURITY.md](SECURITY.md).
53 ## FAQ
55 Our [user FAQ](https://docs.hhvm.com/hhvm/FAQ/faq) has answers to many common questions about HHVM, from [general questions](https://docs.hhvm.com/hhvm/FAQ/faq#general) to questions geared towards those that want to [use](https://docs.hhvm.com/hhvm/FAQ/faq#users).
57 There is also a FAQ for [contributors](https://github.com/facebook/hhvm/wiki/FAQ#contributors) to HHVM.