use README.md for class comments

CampSmalltalk / Cypress

A cross Smalltalk dialect, disk-based package import/export format, inspired by the https://github.com/dalehenrich/filetree project.

MIT License

28 stars 1 forks source link

use README.md for class comments #5

Closed dalehenrich closed 12 years ago

dalehenrich commented 12 years ago

If we use README.md for the class comments, then users can include markup in the class comment for extra richness in the github environment ... markup isn't that bad to read straight up (especially since links can be pushed to the bottom of the post with reference-style links, like this) and straight text is just straight text ...

mkobetic commented 12 years ago

Yup, I agree. That's why the there's STIG.CommentFile global that you can set to whatever you want. Should it default to 'README.md' ?

dalehenrich commented 12 years ago

Yeah, I think we might as well start off on the "right foot" ... with the .md extensions folks will be encourage to use markdown in their class comments ...