Permalink
Browse files

Bring the README up-to-date.

Summary:
- Remove references to being faster than PHP 5.2.
- Point to the official documentation.
- Mention support for PHP 7.
- Rearrange things a little bit.

Reviewed By: fredemmott

Differential Revision: D2738307

fb-gh-sync-id: b1b632ded3dd296f14eb60b2dcff0532791ea995
  • Loading branch information...
1 parent a919525 commit 8087d388b9570252e4a5a47baea416efb4da45e8 @JoelMarcey JoelMarcey committed with hhvm-bot Dec 9, 2015
Showing with 27 additions and 26 deletions.
  1. +27 −26 README.md
View
@@ -1,51 +1,36 @@
# HHVM
[HHVM page](http://hhvm.com) |
+[HHVM documentation](http://docs.hhvm.com/hhvm/) |
[Hacklang page](http://hacklang.org) |
[General group](https://www.facebook.com/groups/hhvm.general/) |
[Dev group](https://www.facebook.com/groups/hhvm.dev/) |
[Twitter](http://twitter.com/HipHopVM)
-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.
+HHVM is an open-source virtual machine designed for executing programs written in [Hack](http://hacklang.org) and [PHP](http://php.net). HHVM uses a just-in-time (JIT) compilation approach to achieve superior performance while maintaining the development flexibility that PHP provides.
-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).
-
-## Reporting and Fixing Security Issues
-
-Please do not open GitHub issues or pull requests - this makes the problem
-immediately visible to everyone, including malicious actors. Security issues in
-HHVM can be safely reported via HHVM's Whitehat Bug Bounty program:
-
-https://www.facebook.com/whitehat
-
-Facebook's security team will triage your report and determine whether or not
-is it eligible for a bounty under our program.
-
-## FAQ
-
-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.
+HHVM supports [Hack](http://hacklang.org), [PHP 5](http://php.net) and the major features of [PHP 7](http://hhvm.com/blog/10859/php-7-support). We are aware of [minor incompatibilities](https://github.com/facebook/hhvm/issues?q=is%3Aopen+is%3Aissue+label%3A%22php5+incompatibility%22), so please [open issues](https://github.com/facebook/hhvm/issues/new) when you find them. HHVM also supports many [extensions](http://docs.hhvm.com/hhvm/extensions/introduction) as well.
+HHVM should be used together with a webserver like the built in, easy to deploy [Proxygen](http://docs.hhvm.com/hhvm/basic-usage/proxygen), or a [FastCGI](http://docs.hhvm.com/hhvm/advanced-usage/fastCGI)-based webserver on top of nginx or Apache.
## Installing
-If you're new, try our [getting started overview](https://github.com/facebook/hhvm/wiki/Getting-Started).
-
-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).
+If you're new, try our [getting started guide](http://docs.hhvm.com/hhvm/getting-started/getting-started).
+You can install a [prebuilt package](http://docs.hhvm.com/hhvm/installation/introduction#prebuilt-packages) or [compile from source](http://docs.hhvm.com/hhvm/installation/building-from-source).
## Running
You can run standalone programs just by passing them to hhvm: `hhvm my_script.php`.
If you want to host a website:
-* Install your favorite webserver
-* Install our [package](https://github.com/facebook/hhvm/wiki/Prebuilt%20Packages%20for%20HHVM)
+* Install your favorite webserver. [Proxygen](http://docs.hhvm.com/hhvm/basic-usage/proxygen) is built in to HHVM, fast and easy to deploy.
+* Install our [package](http://docs.hhvm.com/hhvm/installation/introduction#prebuilt-packages)
* Start your webserver
* Run `sudo /etc/init.d/hhvm start`
-* Visit your site at http://.../index.php
-
-Our [getting started overview](https://github.com/facebook/hhvm/wiki/Getting-Started) provides a slightly more detailed introduction as well as links to more information.
+* Visit your site at `http://.../index.php`
+Our [getting started guide](http://docs.hhvm.com/hhvm/getting-started/getting-started) provides a slightly more detailed introduction as well as links to more information.
## Contributing
@@ -57,7 +42,23 @@ HHVM is licensed under the PHP and Zend licenses except as otherwise noted.
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.
-
## Reporting Crashes
See [Reporting Crashes](https://github.com/facebook/hhvm/wiki/Reporting-Crashes) for helpful tips on how to report crashes in an actionable manner.
+
+## Reporting and Fixing Security Issues
+
+Please do not open GitHub issues or pull requests - this makes the problem
+immediately visible to everyone, including malicious actors. Security issues in
+HHVM can be safely reported via HHVM's Whitehat Bug Bounty program:
+
+[https://www.facebook.com/whitehat](https://www.facebook.com/whitehat)
+
+Facebook's security team will triage your report and determine whether or not
+is it eligible for a bounty under our program.
+
+## FAQ
+
+Our [user FAQ](http://docs.hhvm.com/hhvm/FAQ/faq) has answers to many common questions about HHVM, from [general questions](http://docs.hhvm.com/hhvm/FAQ/faq#general) to questions geared towards those that want to [use](http://docs.hhvm.com/hhvm/FAQ/faq#users).
+
+There is also a FAQ for [contributors](https://github.com/facebook/hhvm/wiki/FAQ#contributors) to HHVM.

0 comments on commit 8087d38

Please sign in to comment.