Skip to content
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.

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

New README #5

Merged
merged 12 commits into from
Jan 17, 2017
Merged

New README #5

merged 12 commits into from
Jan 17, 2017

Conversation

mattgawarecki
Copy link
Contributor

@mattgawarecki mattgawarecki commented Jan 16, 2017

Goal here is to re-format our initial README to match the initial guidelines laid out by @bstarling. This is a first draft -- feedback encouraged!

NOTE: I recommend looking at the readme in this PR in Markdown format: https://github.com/mattgawarecki/drug-spending/blob/readme/README.md

@zachmueller
Copy link
Member

I think it looks good! Some of the content you put together under your FAQ section might be well suited to move over to a D4D "shared" repo at some point. Very awesome to start documenting that kind of thing =) I'll let the other two read through it and provide their own feedback since I've fallen behind on the latest that's happening in this project lol.

@bstarling
Copy link
Contributor

Nice! Might have to borrow some of your wording 👍

@jenniferthompson
Copy link
Contributor

jenniferthompson commented Jan 16, 2017

This is really fantastic, @mattgawarecki!

Might change one thing - based on my (limited) exposure to Jupyter, I think a better corollary would be RMarkdown documents/R Notebooks (using RStudio as an IDE makes it easy to do these, plus RStudio people wrote the RMarkdown package, so it gets fuzzy, but you don't have to have RStudio to create them).

Otherwise I think this is awesome.

@mattgawarecki
Copy link
Contributor Author

@jenniferthompson I've betrayed my naivete of the R ecosystem! 😱 Oh well. :-) I did try to make corrections to the parts I thought you were referencing -- did that do the trick?

@jenniferthompson
Copy link
Contributor

haha! I'm naive about much of this, trust me. :) Looks good - I was also thinking about the line "There are many ways to analyze the data..., ...Jupyter and RStudio."

@zachmueller
Copy link
Member

Overall sounds like @mattgawarecki's edits are a big step in the right direction. Should we go ahead and merge this in then continue iterating on the bits and pieces as we hammer out the details?

@mattgawarecki
Copy link
Contributor Author

I'll go ahead and merge -- looks like the big stuff passed muster and we've just got finer details to knock out. I actually have a couple other things to edit that I'll put into another PR today.

@mattgawarecki mattgawarecki merged commit b7317d0 into Data4Democracy:master Jan 17, 2017
@mattgawarecki mattgawarecki deleted the readme branch January 25, 2017 01:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants