Make README.md file more readable and useful #2815
Conversation
|
Maybe we should also kill the install file from the win32 directory in this pr |
|
Yes, in branches PHP-7.2, PHP-7.1... there are Also the INSTALL file is used by the I would need some more pointers here regarding these files. Basically the INSTALL or install.txt are OK to be added to the release archives for reading offline if they are updated, but from the repository point of view they cause confusion. I think a simplest and most future prone solution would be to have a single entry place php.net/install for all installation information everywhere - in the Git repository and the release archives when downloading PHP. And the installation link added to the README.md (and maybe README.txt for windows environment in case .md file types are arcane on this platform). |
|
But I think I understand what's going on here. Sorry for above confusion. Basically all this has already been thought through and set for master branch using only a single INSTALL file. What about the following?
|
README.md file now includes short description of the php-src repository, some links to Git repository and GitHub mirror and short installation information. When creating windows builds, instead of the install.txt file the README.md file is attached instead. Update windows makedist script
|
A minor update: this pull request now includes the following changes as discussed above:
Commits are squashed into a single one. This is also related to pull request #2792 which will be synced later on to avoid confusions. Thanks... |
|
I'll join two pull requests into one instead for easier understanding of the whole. Closing this pull request in favor of a new one... |
Hello, here are few more refactorings of the
README.mdfile inspired from other open source projects and the Art of README:INSTALLandREADME.WIN32-BUILD-SYSTEMseem redundant and the PHP manual installation chapter has been mentioned in theREADME.mdinstallation section instead.