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

Quick code sample in README #786

Closed
AlexFrazer opened this issue Feb 10, 2015 · 3 comments
Closed

Quick code sample in README #786

AlexFrazer opened this issue Feb 10, 2015 · 3 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@AlexFrazer
Copy link

It would be nice if there was a minimal product included within the README for completely new users to build from source and test that their product is working. A "hello world" code and then how to execute it, really.

@Fishrock123 Fishrock123 added the doc Issues and PRs related to the documentations. label Feb 10, 2015
@rvagg
Copy link
Member

rvagg commented Feb 11, 2015

@AlexFrazer the best course of action here would be for you to propose one via pull request, even if it's terrible you'll end up getting guidance for making it not-terrible and mergable. Something using node -e would be neat I reckon, like making a simple web server on a single line.

@jimmyhsu
Copy link
Contributor

@rvagg I submitted a pull request related to this; just wanted to connect the conversation over from #850.

Any idea where that one liner should go? Seems unclear where the best place would be to put it.

@Trott
Copy link
Member

Trott commented Jul 9, 2015

#850 landed about two weeks ago, addressing this. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

5 participants