More involved README restructuring #764
Conversation
- Move description of Avro, Parquet, Spark to end, in "Under the Hood" section - Clarify simple CLI use of `count_kmers`; save more involved scala-code-snippet for `adam-shell` example later on. - Update some links to non-incubator, yes-apache-project versions. - De-duplicate blocks showing arg-less `adam-submit` and `adam-submit transform` commands and their full output. - Move info about installing Spark and setting up ADAM aliases into "Installing" section
- fix relative intra-page links - update example output of arg-less `adam-submit` and `adam-submit transform` calls - move "applications" to their own section at the end
|
This looks really good to me! Thanks @ryan-williams. I will leave this open for more comment. |
|
|
||
| # Getting Started | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Binary Distributions | ||
|
|
||
| Bundled release binaries can be found on our [releases][] page. |
There was a problem hiding this comment.
Or wait, I think that would point to https://github.com/bigdatagenomics/adam/releases?
|
+1 Ignore my comment noise re: the releases URL. Let's merge this later today. For other reviewers, if you click the "View" button at the top of the "Files Changed" tab you can view the page as it will be displayed. Looks good. |
|
Random related q: what is/should be the purpose of the docs/ directory and its relationship to README.md? Is it published anywhere? |
|
@ryan-williams the |
|
Thanks @ryan-williams! This is great; thanks for taking it on. I've committed this manually as 20ded3d. |
This builds off of #763:
count_kmers; save more involved scala-code-snippet foradam-shellexample later on.adam-submitandadam-submit transformcommands and their full output.There's probably too much going on to get much out of Github's "rich diff", so you might want to just look at the new version in its entirety.