Skip to content

Refactor README.md - #3839

Closed
petk wants to merge 2 commits into
php:PHP-7.4from
petk:patch-readme
Closed

Refactor README.md#3839
petk wants to merge 2 commits into
php:PHP-7.4from
petk:patch-readme

Conversation

@petk

@petkpetk commented Feb 16, 2019

Copy link
Copy Markdown
Member

Hello,

This refactors the README.md file into a bit more useful source of information for people who visit the repository via GitHub and for those who unzip the php-src downloaded release files. README.md file is located in *nix releases, and copied to readme.txt on windows releases. So, the syntax can be Markdown with a bit of a thought for Windows systems where opening *.md files by default requires selecting an application or editor (so probably that's why there is a *.txt done now).

carusogabriel
carusogabriel reviewed Feb 16, 2019
View reviewed changes
Comment threadREADME.md Outdated
@petk
petkforce-pushed the patch-readme branch 2 times, most recently from 8d0f014 to cb92f6bCompareFebruary 17, 2019 16:05
carusogabriel
carusogabriel reviewed Feb 17, 2019
View reviewed changes
Comment threadREADME.md Outdated
javiereguiluz
javiereguiluz reviewed Feb 21, 2019
View reviewed changes

@javiereguiluzjaviereguiluz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thank you.

Comment threadREADME.md Outdated
@petk
petk marked this pull request as ready for review February 24, 2019 10:27
@petk

petk commented Mar 2, 2019

Copy link
Copy Markdown
MemberAuthor

@carusogabriel, @cmb69, @javiereguiluz, @KalleZ, @nikic, @weltling

For the time being I don't have anything to add to README yet ☺️ If there's anything I've missed let me know. In the future pull requests that outdated README.UNIX-BUILD-SYSTEM is also on the todo list to check what can be done with it...

This is good to merge to PHP-7.4+? If so, I can do that in the following days then... Anyway, we can also add major information in next steps if anything comes up.

carusogabriel
carusogabriel reviewed Mar 3, 2019
View reviewed changes
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
@petk@javiereguiluz
@carusogabriel@nhlm
Refactor README.md file
c65c3b1
- 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.txt which is a copy of the README.md. The txt format is used
so the file can be opened in a simple way.
- Add help option for configure and make.
- Mention -j option also 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>
@petk

petk commented Mar 7, 2019

Copy link
Copy Markdown
MemberAuthor

Applied via 2957326 to PHP-7.4+... I'm sure there will be more info to add in this file in the future also... Thank you.

@petkpetk closed this Mar 7, 2019
@petk
petk deleted the patch-readme branch March 7, 2019 01:00
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

3 more reviewers
@javiereguiluzjaviereguiluzjaviereguiluz left review comments
@carusogabrielcarusogabrielcarusogabriel left review comments
@ammarfaizi2ammarfaizi2ammarfaizi2 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

QuickfixWaiting on Review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@petk@javiereguiluz@carusogabriel@ammarfaizi2