atmoschem / EmissV

Create and processing emissions for numeric air quality models
https://atmoschem.github.io/EmissV/
Other
35 stars 10 forks source link

License and author documentation #11

Closed nuest closed 6 years ago

nuest commented 6 years ago

(part of https://github.com/openjournals/joss-reviews/issues/662)

The requirements for the software license are fulfilled, however as a reader I still find it useful to have a reference to the license and the authors in the README file. I suggest to add a short section to the end of the README.

nuest commented 6 years ago

You can also use that section in the README to clarify the involvement of the third author listed in paper.md ( Edmilson Freitas ) who did not contribute via GitHub (https://github.com/atmoschem/EmissV/graphs/contributors).

Schuch666 commented 6 years ago

Hi @nuest I added the short description of the license and the package

nuest commented 6 years ago

My apologies for being unclear, I think it is even better to not repeat legal terms, but just say "This project is published under the X license."

In you case

EmissV is published under the terms of the MIT License. Copyright (c) 2018 Daniel Schuch.
Schuch666 commented 6 years ago

Thank you @nuest

I'm no much experience in software documentation

Schuch666 commented 6 years ago

@nuest updated