Skip to content

Commit 2957326

Browse files
petkjaviereguiluzcarusogabrielnhlm
committed
Refactor README.md file
- Initial refactorings of the README.md file with some more user oriented information about the php-src repository and PHP in general. - SVG logo added - README.WIN32-BUILD-SYSTEM file contents moved to README.md - INSTALL file contents moved to README.md - Windows releases now instead of install.txt file ship with the README.md. - A brief installation section added with help options mentioned for the configure and make. - Also mentioned the `-j` option for build and tests Co-authored-by: Javier Eguiluz <[email protected]> Co-authored-by: Gabriel Caruso <[email protected]> Co-authored-by: Matthias Kaschubowski <[email protected]>
1 parent c348ed1 commit 2957326

File tree

5 files changed

+96
-38
lines changed

5 files changed

+96
-38
lines changed

INSTALL

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.WIN32-BUILD-SYSTEM

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.md

Lines changed: 95 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,111 @@
1-
The PHP Interpreter
2-
===================
1+
<div align="center">
2+
<a href="https://php.net">
3+
<img
4+
alt="PHP"
5+
src="https://static.php.net/www.php.net/images/logos/new-php-logo.svg"
6+
width="150">
7+
</a>
8+
</div>
39

4-
This is the github mirror of the official PHP repository located at
5-
https://git.php.net.
10+
# The PHP Interpreter
611

7-
[![Build Status](https://secure.travis-ci.org/php/php-src.svg?branch=master)](http://travis-ci.org/php/php-src)
12+
PHP is a popular general-purpose scripting language that is especially suited to
13+
web development. Fast, flexible and pragmatic, PHP powers everything from your
14+
blog to the most popular websites in the world. PHP is distributed under the PHP
15+
License v3.01.
16+
17+
[![Build status](https://travis-ci.org/php/php-src.svg?branch=master)](https://travis-ci.org/php/php-src)
818
[![Build status](https://ci.appveyor.com/api/projects/status/meyur6fviaxgdwdy?svg=true)](https://ci.appveyor.com/project/php/php-src)
919

10-
Pull Requests
11-
=============
12-
PHP accepts pull requests via github. Discussions are done on github, but
13-
depending on the topic can also be relayed to the official PHP developer
14-
mailing list [email protected].
20+
## Documentation
21+
22+
The PHP manual is available at [php.net/docs](https://php.net/docs).
23+
24+
## Installation
25+
26+
### Prebuilt packages and binaries
27+
28+
Prebuilt packages and binaries can be used to get up and running fast with PHP.
29+
30+
For Windows, the PHP binaries can be obtained from
31+
[windows.php.net](https://windows.php.net). After extracting the archive the
32+
`*.exe` files are ready to use.
33+
34+
For other systems, see the [installation chapter](https://php.net/install).
35+
36+
### Building PHP from source
37+
38+
On \*nix systems:
39+
40+
./buildconf
41+
./configure
42+
make
43+
make test
44+
sudo make install
1545

16-
New features require an RFC and must be accepted by the developers.
17-
See https://wiki.php.net/rfc and https://wiki.php.net/rfc/voting for more
18-
information on the process.
46+
See `./configure -h` and `make -h` for configuration options. For example, the
47+
`-j` option allows parallel execution of the build recipes where `N` is the
48+
number of available processor cores:
1949

20-
Bug fixes **do not** require an RFC, but require a bugtracker ticket. Always
21-
open a ticket at https://bugs.php.net and reference the bug id using #NNNNNN.
50+
make -j N
51+
52+
For Windows, see
53+
[Build your own PHP on Windows](https://wiki.php.net/internals/windows/stepbystepbuild_sdk_2).
54+
55+
## PHP extensions
56+
57+
Extensions provide additional functionality on top of PHP. PHP consists of many
58+
essential bundled extensions. Additional extensions can be found in the PHP
59+
Extension Community Library - [PECL](https://pecl.php.net).
60+
61+
## Contributing
62+
63+
The PHP source code is located in the Git repository at
64+
[git.php.net](https://git.php.net). Contributions are most welcome by forking
65+
the [GitHub mirror repository](https://github.com/php/php-src) and sending a
66+
pull request.
67+
68+
Discussions are done on GitHub, but depending on the topic can also be relayed
69+
to the official PHP developer mailing list [email protected].
70+
71+
New features require an RFC and must be accepted by the developers. See
72+
[Request for comments - RFC](https://wiki.php.net/rfc) and
73+
[Voting on PHP features](https://wiki.php.net/rfc/voting) for more information
74+
on the process.
75+
76+
Bug fixes **do not** require an RFC but require a bug tracker ticket. Open a
77+
ticket at [bugs.php.net](https://bugs.php.net) and reference the bug id using
78+
`#NNNNNN`.
2279

2380
Fix #55371: get_magic_quotes_gpc() throws deprecation warning
2481

25-
After removing magic quotes, the get_magic_quotes_gpc function caused
26-
a deprecate warning. get_magic_quotes_gpc can be used to detected
27-
the magic_quotes behavior and therefore should not raise a warning at any
28-
time. The patch removes this warning
82+
After removing magic quotes, the get_magic_quotes_gpc function caused a
83+
deprecated warning. get_magic_quotes_gpc can be used to detect the
84+
magic_quotes behavior and therefore should not raise a warning at any time.
85+
The patch removes this warning.
2986

30-
We do not merge pull requests directly on github. All PRs will be
31-
pulled and pushed through https://git.php.net.
87+
Pull requests are not merged directly on GitHub. All PRs will be pulled and
88+
pushed through [git.php.net](https://git.php.net). See
89+
[Git workflow](https://wiki.php.net/vcs/gitworkflow) for more details.
3290

91+
### Guidelines for contributors
3392

34-
Guidelines for contributors
35-
===========================
36-
- [CODING_STANDARDS](/CODING_STANDARDS)
37-
- [README.GIT-RULES](/README.GIT-RULES)
38-
- [README.MAILINGLIST_RULES](/README.MAILINGLIST_RULES)
39-
- [README.RELEASE_PROCESS](/README.RELEASE_PROCESS)
93+
See further documents in the repository for more information on how to
94+
contribute:
95+
96+
- [Contributing to PHP](/CONTRIBUTING.md)
97+
- [PHP coding standards](/CODING_STANDARDS)
98+
- [Git rules](/README.GIT-RULES)
99+
- [Mailinglist rules](/README.MAILINGLIST_RULES)
100+
- [PHP release process](/README.RELEASE_PROCESS)
40101

41102
## Testing
42103

43-
To run tests the `make test` is used after successful compilation of the sources.
104+
To run tests the `make test` is used after a successful compilation of the
105+
sources. The `-j` option provides faster parallel execution based on the number
106+
of cores (`N`):
107+
108+
make -j N test
44109

45-
See [Creating new test files](https://qa.php.net/write-test.php) chapter for more
46-
information about testing.
110+
The [qa.php.net](https://qa.php.net) site provides more detailed info about
111+
testing and quality assurance.

win32/build/Makefile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,6 @@ snap: build-snap build-devel build-dist
229229
$(BUILD_DIR)\deplister.exe: win32\build\deplister.c
230230
$(CC) /nologo /Fo$(BUILD_DIR)\ /Fd$(BUILD_DIR)\ /Fp$(BUILD_DIR)\ /FR$(BUILD_DIR) /Fe$(BUILD_DIR)\deplister.exe win32\build\deplister.c imagehlp.lib
231231

232-
# need to redirect, since INSTALL is a file in the root...
233232
install: really-install install-sdk
234233

235234
build-lib: build-ext-libs

win32/build/mkdist.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ function extract_file_from_tarball($pkg, $filename, $dest_dir) /* {{{ */
251251
$text_files = array(
252252
"LICENSE" => "license.txt",
253253
"NEWS" => "news.txt",
254-
"INSTALL" => "install.txt",
254+
"README.md" => "README.md",
255255
"README.REDIST.BINS" => "readme-redist-bins.txt",
256256
"php.ini-development" => "php.ini-development",
257257
"php.ini-production" => "php.ini-production"

0 commit comments

Comments
 (0)