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

Already on GitHub? Sign in to your account

Convert README to Markdown #3393

Merged
merged 1 commit into from Feb 28, 2014

Conversation

Projects
None yet
4 participants
Contributor

christianbundy commented Feb 28, 2014

This pull request renames README to README.md as well as adding various Markdown goodies to make it look better on the web.

Contributor

davidchambers commented Feb 28, 2014

This should make https://www.npmjs.org/package/coffee-script a bit more readable. :)

@epidemian epidemian commented on the diff Feb 28, 2014

README.md
+ `-.._________..-' | |
+ |_|
+
+CoffeeScript is a little language that compiles into JavaScript.
+
+## Installation
+
+If you have the Node Package Manager installed:
+
+```shell
+npm install -g coffee-script
+```
+
+Leave off the -g if you don't wish to install globally.
+
+---
@epidemian

epidemian Feb 28, 2014

Contributor

This


looks kind of weird here IMO.

Other than that, nice PR 👍

@christianbundy

christianbundy Feb 28, 2014

Contributor

Thanks! I'm not diehard about any of the markup here, feel free to change whatever you'd like. I wasn't sure how to make the "Leave off the -g if you don't wish to install globally." not look weird, and thought a horizontal rule would be better than removing it entirely.

@jashkenas jashkenas added a commit that referenced this pull request Feb 28, 2014

@jashkenas jashkenas Merge pull request #3393 from christianbundy/markdown-readme
Convert README to Markdown
75207a0

@jashkenas jashkenas merged commit 75207a0 into jashkenas:master Feb 28, 2014

@christianbundy christianbundy deleted the christianbundy:markdown-readme branch Feb 28, 2014

@christianbundy christianbundy restored the christianbundy:markdown-readme branch Feb 28, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment