archivesunleashed / aut

The Archives Unleashed Toolkit is an open-source toolkit for analyzing web archives.

https://aut.docs.archivesunleashed.org/

Apache License 2.0

137 stars 33 forks source link

Updates read.me to include citation section #500

Closed SamFritz closed 4 years ago

SamFritz commented 4 years ago

GitHub issue(s):

This PR addresses Issue-497: Update Read.me w/ citation information

What does this Pull Request do?

Adds in a section in the AUT read.me to identify how folks should cite AU tools. Implementation based on discussion in the ticket, specifically how how citation should be formatted.

Interested parties

@ianmilligan1 thanks for your final review; please feel free to adjust any of the wording!

codecov[bot] commented 4 years ago

Codecov Report

Merging #500 into main will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##               main     #500   +/-   ##
=========================================
  Coverage     88.85%   88.85%           
  Complexity       57       57           
=========================================
  Files            43       43           
  Lines          1014     1014           
  Branches         86       86           
=========================================
  Hits            901      901           
  Misses           74       74           
  Partials         39       39

SamFritz commented 4 years ago

checked indentation of citation (so it comes out more of like a block quote) looks good! and will update all citations so Proceedings portion is italicized. Thanks @ianmilligan1!

ianmilligan1 commented 4 years ago

Great, looks good to me @SamFritz. I will let @ruebot do a final review + merge when he is available as I think of him as the keeper of all things AUT.