Skip to content

Commit 7ef3aef

Browse files
committed
Minor readme changes
1 parent b6ffc37 commit 7ef3aef

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

README.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ https://www.php.net/docs.php
1313
# How to write phpdoc files
1414

1515
If you are interested in information about how to
16-
set up the tools needed, how to work with git and
16+
set up the tools needed, how to work with Git and
1717
DocBook on Linux or Windows, or what conventions you
1818
should follow when writing phpdoc files, please refer
1919
to the PHP Documentation HOWTO.
@@ -36,9 +36,9 @@ https://wiki.php.net/doc/phd
3636
### Source checkout
3737

3838
For a more general git-workflow see [the Wiki](https://wiki.php.net/vcs/gitworkflow#reviewing_and_closing_pull_requests).
39-
Make sure to upload your SSH-key to your account at people.php.net
39+
Make sure to upload your SSH public key to your account at master.php.net
4040

41-
Check out the source
41+
Check out the sources:
4242

4343
```bash
4444
mkdir phpdoc
@@ -50,7 +50,7 @@ git clone [email protected]:/doc/base.git doc-base
5050

5151
Change `your-language-of-choice` if you would like to check out a different language.
5252

53-
Where `en/` contains the DocBook source files, and `doc-base` contains tools
53+
The `en` folder contains the English DocBook source files, and `doc-base` contains tools
5454
and resources used in all languages.
5555

5656
### Edits
@@ -60,15 +60,14 @@ and resources used in all languages.
6060
```bash
6161
git diff path/to/file.xml
6262
```
63-
6463
* Make sure no errors are present, so at the command line in your phpdoc source directory run:
6564
```bash
66-
php doc-base/configure.php
65+
php configure.php
6766
```
68-
* If you are translating, remember to add the full hash of the english base-file that you are translating
69-
from, to the files `EN-Revision`-comment
67+
* If you are translating, remember to add the full Git commit hash of the English file that you are translating
68+
from, to the file's `EN-Revision` comment.
7069

71-
**Always run `php configure.php` before commit!**
70+
**Always run `php doc-base/configure.php` before commit!**
7271
* Commit your changes
7372
```bash
7473
git commit path/to/file.xml
@@ -80,11 +79,11 @@ and concerns.
8079

8180
### New functions
8281

83-
* Copy an existing xml file or use a skeleton from the HOWTO.
82+
* Copy an existing XML file or use a skeleton from the HOWTO.
8483
Rename and place it into the appropriate directory.
8584
* Edit. Be sure no leftover text exists. No tabs either.
86-
* If you are translating, remember to add the full commit-hash of the english
87-
base-file that you are translating from, to the files `EN-Revision`-comment.
85+
* If you are translating, remember to add the full Git commit hash of the English
86+
file that you are translating from, to the file's `EN-Revision` comment.
8887
* Now test locally before commit by first running
8988
```bash
9089
php configure.php
@@ -98,10 +97,7 @@ and concerns.
9897
git commit path/to/yourfile.xml
9998
git push remote your-branch
10099
```
101-
* Open a PullRequest to the main repository via github
102-
103-
Note that the version numbers are taken care of elsewhere (don't worry
104-
about them)
100+
* Open a pull request to the main repository via GitHub
105101

106102
### Some popular tags and entities
107103

@@ -129,7 +125,6 @@ about them)
129125
&false; <constant>FALSE</constant>
130126
&php.ini; <filename>php.ini</filename>
131127

132-
Be sure to check out globals.ent and language-snippets.ent for
133-
more information for entities and urls.
134-
135-
---------------------------------------------------------------------------
128+
Be sure to check out [global.ent](entities/global.ent) and
129+
language-snippets.ent (located within each language's repo) for
130+
more information for entities and URLs.

0 commit comments

Comments
 (0)