com web/php: Add a README file on how to setup a development env: README.md
| From: | Hannes Magnusson | Date: | Wed, 04 Dec 2013 04:48:17 +0000 |
| Subject: | com web/php: Add a README file on how to setup a development env: README.md | ||
| Groups: | php.webmaster | ||
| Request: | Send a blank email to php-webmaster+get-17332@lists.php.net to get a copy of this message | ||
Commit: a96814d7363e04b480853a89c9a929d46fe07903
Author: Hannes Magnusson <bjori@mongodb.com> Tue, 3 Dec 2013 20:48:17 -0800
Parents: 5b3f6d3fdbe7d2f5ed01d5f38b8f7257e0b99e7e
Branches: master
Link: http://git.php.net/?p=web/php.git;a=commitdiff;h=a96814d7363e04b480853a89c9a929d46fe07903
Log:
Add a README file on how to setup a development env
Changed paths:
A README.md
Diff:
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3b2ff24
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+## Local development
+
+This is the git repo for the official www.php.net website.
+
+To setup a local mirror of the website:
+
+ $ git clone https://github.com/php/web-php.git
+ $ cd web-php
+ $ php -S localhost:8080 .router.php
+
+
+This repo does include most (generated) files that are required for normal
+operation of this website, such as
+
+ - News & events data
+ - Several manual pages (and a translation), see manual/{en,ja}/
+ - User contributed notes for manual pages
+ - A "router" for the builtin PHP webserver
+
+
+## Setting up an official mirror
+
+To install a full official mirror please see [the mirroring guidelines](http://php.net/mirroring).
+
+