Create README.md

This file contains the process to be used after moving over to git. The content is the same as from the README, only the commands have been transfered from svn to git with the addition of the extra process of maintaining the `.en-revisions.ref` file

Closes GH-5

Author: heiglandreas

README.md

@@ -0,0 +1,136 @@
+
+# READ THIS FIRST
+    
+This directory contains source files and a setup for converting
+PHP's XML documentation into presentation formats like HTML and
+RTF. You should not have to bother with this unless you are
+writing documentation yourself, or if you simply are curious
+about how the XML stuff works.
+
+If you just want to read the documentation, look at:
+http://www.php.net/docs.php
+
+# HOW TO WRITE PHPDOC FILES
+
+If you are interested in information about how to
+set up the tools needed, how to work with git and
+DocBook on Linux or Windows, or what conventions you
+should follow when writing phpdoc files, please refer
+to the PHP Documentation HOWTO.
+     
+You can read the HOWTO online at: http://doc.php.net/tutorial/
+    
+If you are already working with the phpdoc module,
+then you can find its XML source in the howto directory
+of the module, and build it yourself with:
+
+```bash
+phd -d .manual.xml
+```
+
+However, PhD is a separate project which can be read about here:
+http://wiki.php.net/doc/phd
+
+## QUICK REFERENCE
+
+### source checkout
+
+For a more general git-workflow see [the Wiki](https://wiki.php.net/vcs/gitworkflow#reviewing_and_closing_pull_requests). 
+Make sure to upload your SSH-key to your account at people.php.net
+  
+Check out the source
+
+```bash
+mkdir phpdoc
+cd phpdoc
+git clone [email protected]:/doc/en.git
+git clone [email protected]:/doc/your-language-of-choice.git
+git clone [email protected]:/doc/base.git doc-base
+```
+
+Change `your-language-of-choice` if you would like to check out a different language.
+         
+Where `en/` contains the DocBook source files, and `doc-base` contains tools
+and resources used in all languages.
+  
+### edits
+    
+* Make the change.  Use spaces not tabs.  Be sure to carefully watch your whitespace!
+* Look at your unified diff, make sure it looks right and that whitespace changes aren't mixed in:
+  ```bash
+  git diff path/to/file.xml
+  ```
+  	 
+* Make sure no errors are present, so at the command line in your phpdoc source directory run:
+  ```bash
+  php doc-base/configure.php
+  ```  
+* If you are translating, remember to add the full hash of the english base-file that you are translating 
+  from, to the files `EN-Revision`-comment
+  
+  **Always run `php configure.php` before commit!**
+* Commit your changes
+  ```bash
+  git commit path/to/file.xml
+  ```
+	 
+Read the HOWTO for more information.  After reading the HOWTO,
+email the phpdoc mailing list ([email protected]) with questions 
+and concerns.
+
+### new functions
+  
+* Copy an existing xml file or use a skeleton from the HOWTO. 
+  Rename and place it into the appropriate directory.
+* Edit.  Be sure no leftover text exists.  No tabs either.
+* If you are translating, remember to add the full commit-hash of the english 
+  base-file that you are translating from, to the files `EN-Revision`-comment.
+* Now test locally before commit by first running
+  ```bash
+  php configure.php
+  ```
+* Add the file to your staging area
+  ```bash
+  git add path/to/yourfile.xml
+  ```
+* Commit the file and push it to the git-server
+  ```bash
+  git commit path/to/yourfile.xml
+  git push remote your-branch
+  ```
+* Open a PullRequest to the main repository via github
+  
+Note that the version numbers are taken care of elsewhere (don't worry 
+about them)
+
+### some popular tags and entities
+   
+    <filename>          filenames
+    <constant>          constants
+    <varname>           variables
+    <parameter>         a function's parameter/argument
+    <function>          functions, this links to function pages or bolds if 
+                        already on the function's page.  it also adds ().
+    
+    <literal>           teletype/mono-space font <tt>
+    <emphasis>          italics
+    <example>           see HOWTO, includes many other tags.
+    <link>              internal manual links
+                        <link linkend="language.variables">variables</link>
+    
+    <link>              external links via global.ent
+                        <link xlink:href="&spec.cookies;">mmm cookies</link>                        
+    
+    <type>              types, this links to the given types manual
+                        page: <type>object</type> -> php.net/types.object
+    
+
+    &return.success;    see: language-snippets.ent
+    &true;              <constant>TRUE</constant>
+    &false;             <constant>FALSE</constant>
+    &php.ini;           <filename>php.ini</filename>
+
+ Be sure to check out globals.ent and language-snippets.ent for
+ more information for entities and urls.
+
+---------------------------------------------------------------------------