Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: shorten intro of README.md #23073

Closed
wants to merge 1 commit into from
Closed

Commits on Oct 6, 2018

  1. doc: shorten intro of README.md

    There are many things I might want to know about if I'm reading the
    introduction of the README file for Node.js: Where to get help, what the
    latest release is, how to compile from source, where to report bugs, how
    to contribute...
    
    One thing I cannot imagine wondering about is, "I wonder if there is a
    foundation that supports Node.js." Move that sentence to the end of the
    paragraph as it is designed to serve the project and not the end user.
    
    Bonus: This removes a usage of passive voice.
    
    The Linux kernel README does not mention the Linux Foundation.
    https:/torvalds/linux/blob/master/README
    
    The jQuery README does not mention the JS Foundation.
    https:/jquery/jquery/blob/master/README.md
    (It does mention the no-longer-extant jQuery Foundation but only because
    the Foundation itself apparently had coding standards.)
    
    The Python README only mentions the Python Software Foundation as the
    copyright owner.
    
    The Apache httpd README does mention the Apache Software Foundation
    although it does not link to it and it is mentioned in passing rather
    than being the topic of a declarative sentence.
    Trott committed Oct 6, 2018
    Configuration menu
    Copy the full SHA
    0bfb678 View commit details
    Browse the repository at this point in the history