Bioconductor / packagebuilder

5 stars 7 forks source link

Feature/improved documentation #16

Closed b-long closed 8 years ago

b-long commented 8 years ago

@jimhester I don't want to merge this in quite yet, but wanted to make you generally aware of it. I figured it might be simpler to grasp the README.md by pulling installation and debugging information out into their own markdown files. I'll clean this up once I get some time, but for the purposes of documentation, feel free to commit atop my changes in this branch.

b-long commented 8 years ago

cc/ @jimhester Any thoughts on this PR? I think now is a decent time to begin this cleanup as I'm working on getting the SPB to run without Morelia (as per https://github.com/Bioconductor/BBS/issues/30 )

jimhester commented 8 years ago

It might be better to just move the references to the deprecated node app to another file that documents it rather than keeping them interspersed throughout.

Other than that I think it is fine.

b-long commented 8 years ago

Seems reasonable, thanks Jim.