Commit Graph

20 Commits

Author SHA1 Message Date
Joe Watkins
d116343818
azure image update [not skipping on purpose to test new configuration] 2019-06-09 13:39:35 +02:00
Joe Watkins
cb9bb146d9
add azure pipelines badge to readme [ci skip] 2019-06-04 17:11:16 +02:00
Peter Kokot
f45b61b898 [ci skip] Migrate Coding standards docs to Markdown 2019-05-18 21:41:38 +02:00
Peter Kokot
1c94aac89e [ci skip] Fix CS in Markdown files
Checked and quickfixed with Markdown linter
- 80 columns line width (~)
- code highlighting
- ...

Some most obvious outdated content updated a bit more.
2019-04-21 15:33:20 +02:00
Peter Kokot
47c5fa0710 [ci skip] Fix logo location 2019-04-21 03:16:11 +02:00
Joe Watkins
2c78b80e1e
typo [ci skip] 2019-03-31 09:46:55 +02:00
Joe Watkins
79c6636f15
correct readme [ci skip] 2019-03-31 09:43:53 +02:00
Peter Kokot
8346b4c9f1 Move README files to a dedicated docs directory
The new dedicated docs directory has been introduced after a discussion
on GitHub[1].

Main issue it is addressing is the reduction of too many README files in
the project root directory. The new directory is dedicated for notes and
quick documentation files that either can't be put in the manual or wiki
pages or that relate to the php-src repository specifically and need to
live together with the source code.

Also the `docs` directory is by GitHub used for some repository
configuration files such as pull request templates, and contributing
documentation helper files that are integrated in the interface.

[1]: https://github.com/php/php-src/pull/3988
2019-03-30 19:38:34 +01:00
Peter Kokot
a8e879c53f Join README.GIT-RULES and CONTRIBUTING.md
This patch joins two very much related pieces of docs together in a
single file dedicated to all sorts of contributing info.

Some more changes:
- Branches info copied from the current master branch
- LXR and bonsai info removed
- Duplicated info reduced a bit
- Security branch updated to 7.1
- Refactor intro for Git commit rules
- Updated README.GIT-RULES file usage in win32/build/confutils.js
- Refactored configure.ac
2019-03-30 15:58:23 +01:00
Peter Kokot
092ebd032c [ci skip] Move CREDITS from root to README 2019-03-24 01:57:19 +01:00
Peter Kokot
86f2681460 [ci skip] Remove make install step from README
The `make install` step touches files outside of the source directory
and might cause confusions with people. It should be mentioned in more
details elsewhere in the installation chapter instead and how to
override it.
2019-03-16 18:37:49 +01:00
Peter Kokot
2957326956 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 <javier.eguiluz@gmail.com>
Co-authored-by: Gabriel Caruso <carusogabriel34@gmail.com>
Co-authored-by: Matthias Kaschubowski <nihylum@gmail.com>
2019-03-07 01:57:53 +01:00
Peter Kokot
0e60b812c0 Move all testing docs to qa.php.net
The qa.php.net currently includes nice collection of information about
tests and how to run them. Instead of maintaining two locations of this
information, this patch removes the README.TESTING from the php-src
repo. Patch for qa.php.net has been sent separately to that repo.
2018-10-18 08:01:22 +02:00
Peter Kokot
1ad08256f3 Sync leading and final newlines in source code files
This patch adds missing newlines, trims multiple redundant final
newlines into a single one, and trims redundant leading newlines.

According to POSIX, a line is a sequence of zero or more non-' <newline>'
characters plus a terminating '<newline>' character. [1] Files should
normally have at least one final newline character.

C89 [2] and later standards [3] mention a final newline:
"A source file that is not empty shall end in a new-line character,
which shall not be immediately preceded by a backslash character."

Although it is not mandatory for all files to have a final newline
fixed, a more consistent and homogeneous approach brings less of commit
differences issues and a better development experience in certain text
editors and IDEs.

[1] http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206
[2] https://port70.net/~nsz/c/c89/c89-draft.html#2.1.1.2
[3] https://port70.net/~nsz/c/c99/n1256.html#5.1.1.2
2018-10-14 12:56:38 +02:00
Dusta
da82719f20
Update http to https 2018-06-25 08:31:32 +02:00
Anatol Belski
3a886c9d20 add build status badge 2016-12-16 11:53:41 +01:00
xiabeifeng
33aba29768 Fix typo 2016-06-04 19:06:59 +02:00
Peter Dave Hello
852c2fc18d Use svg instead of png to get better image quality 2015-01-25 13:15:41 +08:00
Hannes Magnusson
f8f643b4f7 Link to more readmes 2013-10-27 16:40:37 -07:00
David Soria Parra
54d85308eb Add preliminary README.md for github
Github uses a special markdown syntax and display the content of the README
formatted on the front page of the repo. This readme contains information for
github users.
2012-06-03 18:49:47 +02:00