Add "How to cite" to readme

[pombredanne]

from https://github.com/nexB/scancode-toolkit/issues/54#issuecomment-130385056 by @retrography:

We can't include that kind of disclaimer in an academic paper. An academic citation follows a very specific format. I give you an example from the statnet package that I use regularly for my analysis:

Handcock M, Hunter D, Butts C, Goodreau S, Krivitsky P, Bender-deMoll S and Morris M (2015). statnet: Software Tools for the Statistical Analysis of Network Data. The Statnet Project.

You can also provide the bibliographic entry, so that the users can format the citation according to the outlet they publish in:

@Misc{,
  author = {Mark S. Handcock and David R. Hunter and Carter T. Butts and Steven M. Goodreau and Pavel N. Krivitsky and Skye Bender-deMoll and Martina Morris},
  title = {statnet: Software Tools for the Statistical Analysis of Network Data},
  organization = {The Statnet Project (\url{http://www.statnet.org})},
  year = {2015},
  note = {R package version 2015.6.2},
  url = {CRAN.R-project.org/package=statnet},
}

Have a look at here: https://en.wikipedia.org/wiki/BibTeX

[HarshKhatore]

@pombredanne Can you guide on what is to be done, as this would be my first issue to solve. Also, how is #54 linked to this?

[pombredanne]

54 was where this issue was originally raised. I barely went to school ;) so I have no idea on how to cite. @retrography could you help there?

[retrography]

@pombredanne @HarshKhatore I would say simply fill in the blanks:

@Misc{,
  author = { },
  title = { },
  organization = { },
  year = { },
  note = { },
  url = { },
}

Note and Organization are optional. It needs a decision by the team who should be on the main list of authors. With the BibTex citation, anyone (including me) can generate the proper citations in the right formats (APA, etc.) to be included here.

[Chaitya62]

@retrography @pombredanne Can we use Zenodo instead it provides option to export the cite in various formats too.

[pombredanne]

@Chaitya62 why not? what would this entail?

[Chaitya62]

@pombredanne with Zenodo we can create a DOI as well as an easy way to generate citations in a number of formats. I found about it here, it also has the steps to do it.

[pombredanne]

@Chaitya62 thanks, what we need here is a simple addition to the README or doc that would provide the basic citation

[AyanSinhaMahapatra]

@pombredanne Can I go ahead and do this? (I've done citation stuff before) IMHO Zenodo DOI's are indeed a good option, as it will set up a webhook to archive and cite individual releases (third-party access to zenodo has to be given), and we'll have DOI numbers (basically unique identifiers for citing) for them which will make the citation process simpler and better. Then I'll add relevant documentation in the README (zenodo also has DOI badges) and a small "How To Cite" page.

[pombredanne]

@AyanSinhaMahapatra please do! thanks