Skip to content

doc: added a quick "Hello World" example in README #850

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.

Sign up for GitHub

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

Closed
jimmyhsu wants to merge 4 commits into from
Closed

doc: added a quick "Hello World" example in README #850

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7e49cc3
Added a quick "Hello World" example to README.md
jimmyhsu Feb 15, 2015
493ff68
Moved quick "Hello World" test to bottom
jimmyhsu Feb 15, 2015
028048d
Moved tests into OSX/Unix and Windows sections
jimmyhsu Feb 16, 2015
f2a13a8
Shortened unnecessarily long wording for tests
jimmyhsu Feb 16, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added a quick "Hello World" example to README.md 
New code added to help completely new users test if their build-from-source is working correctly.
  • Loading branch information
@jimmyhsu
jimmyhsu committed Feb 15, 2015
commit 7e49cc3fc64c874cb6224aab93cac5eda199efed
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ the binary verification command above.

## Build

To quickly test that io.js was built correctly from any of the steps below:
Copy link
Copy Markdown
Contributor

@cjihrig cjihrig Feb 15, 2015

Choose a reason for hiding this comment

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

I don't think it makes sense to explain how to test the build before building. I'd move this to the end of the build instructions.

Copy link
Copy Markdown
Contributor Author

@jimmyhsu jimmyhsu Feb 15, 2015

Choose a reason for hiding this comment

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

I wrestled with this myself, but I was afraid that leaving it at the bottom some people might miss it. I know personally I may have done so myself.

Copying it in each of the different OS instructions seems to be another option, but my thoughts are that it would make the readme too verbose.

Regardless, I'm with you on the logical progression as to where it should be placed. Bottom does make the most sense.

Thoughts or should we stick to putting it at the bottom?

Copy link
Copy Markdown
Member

@jbergstroem jbergstroem Feb 15, 2015

Choose a reason for hiding this comment

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

I'm with @cjihrig. Why test something that isn't built yet? Regarding people not reading a readme -- well, that's not too much to do about.

Copy link
Copy Markdown
Contributor Author

@jimmyhsu jimmyhsu Feb 15, 2015

Choose a reason for hiding this comment

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

@jbergstroem, good point. I've updated the pull request with a new commit that moves it to the bottom.

```
$ iojs -e "console.log('Hello, world')"
```

### Unix / Macintosh

Prerequisites:
Expand Down