Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Updates to readme about documentation, communication & license. #916
Conversation
tfenne
requested review from lbergelson and jacarey
Jun 26, 2017
codecov-io
commented
Jun 26, 2017
•
Codecov Report
@@ Coverage Diff @@
## master #916 +/- ##
===========================================
Coverage 65.138% 65.138%
Complexity 7281 7281
===========================================
Files 528 528
Lines 31975 31975
Branches 5469 5469
===========================================
Hits 20828 20828
Misses 8992 8992
Partials 2155 2155 |
| -#### Building HTSJDK | ||
| +### Documentation & Getting Help | ||
| + | ||
| +API documentation for all versions of HTSJDK since `1.128` are available through [javadoc.io](http://www.javadoc.io/doc/com.github.samtools/htsjdk). |
| + | ||
| +Not all sub-packages of htsjdk are subject to the same license, so a license notice is included in each source file or sub-package as appropriate. | ||
| +Please check the relevant license notice whenever you start working with a part of htsjdk that you have not previously worked with to avoid any surprises. | ||
| +Broadly speaking the majority of the code is covered under the MIT license with the following notable exceptions: |
lbergelson
Jul 7, 2017
Contributor
This is a gross mess. Hopefully when Broad legal gets back from vacation we can resolve at least the lgpl bits.
| -#### Java Minimum Version Support Policy | ||
| +### Java Minimum Version Support Policy | ||
| > **NOTE: _Effective November 24th 2015, HTSJDK has ended support of Java 7 and previous versions. Java 8 is now required_.** |
lbergelson
Jul 7, 2017
Contributor
Should we remove this notice? It's been around for a long time now. Anyone who cares probably knows.
tfenne
Jul 10, 2017
Owner
I removed the note and updated the proposed data for Java 8 to be one our from this month as that's probably when Oracle will stop support for Java 8 (one year from the next major release).
|
@jacarey Do you want to review this? How about I merge tomorrow if I don't hear from you, and you can just say "yes I want to review" to postpone that? |
pshapiro4broad
commented
Jul 10, 2017
|
@pshapiro4broad I hear you ... although in fairness this PR is two weeks old ;) I'll wait until Wednesday. |
|
@tfenne I'll review it today. Thanks! |
tfenne commentedJun 26, 2017
Description
Updated the readme to include more information on licensing, updated links to documentation and suggestions on how to interact with the project.
Checklist