Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

adding Readme.md #2

Open
arunoda opened this Issue · 0 comments

2 participants

@arunoda
Collaborator

Every project need an documentation/howto guide. We simply do this with a README file on the top level project directory.

Readme file is typically written in format called markdown and readme file is named as README.md.

  • learn markdown here
  • use this editor to try markdown online
  • sample README.md file can be found in the repo - https://github.com/arunoda/node-usage
  • click the README.md file (github render markdown into HTML)
  • inoder to find the markdown syntax itself, click the raw button as shown below
  • github uses their version of markdown with it's features. Check it here.

Screen Shot 2013-04-11 at 3 47 26 PM 2

At the end, create your own README.md file for this project and describe someone who is not familiar with nodejs to use this project. :)

@nadee013 nadee013 was assigned
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.