Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

License auto detection in the README file #58

Open
abderraouf-adjal opened this issue Sep 1, 2015 · 6 comments
Open

License auto detection in the README file #58

abderraouf-adjal opened this issue Sep 1, 2015 · 6 comments

Comments

@abderraouf-adjal
Copy link

Hello,
I suggest auto detection for the license in the README file.

@basicallydan
Copy link
Owner

Ooh I like it! Yes! Very good idea.

We could store a list of all the main licences and search the readme for the text. Or we could simply look for the word "licence". Thoughts? Any more ideas?

@abderraouf-adjal
Copy link
Author

Searching word License & Copyright in README or README.md or README.txt headlines...

@thinkingmedia
Copy link

I implement a LICENSE detection scheme for a readme generator. It works by parsing the LICENSE file with a high accuracy. Can match licenses even if the file has been edited.

The code is implemented here:

https://github.com/thinkingmedia/readme-plus/blob/master/src/services/licenses.js

It requires a cache of LICENSE files that are used as reference:

https://github.com/thinkingmedia/readme-plus/tree/master/src/services/_licenses

Would you like a pull request for this feature?

@M-Zuber
Copy link
Collaborator

M-Zuber commented Dec 8, 2015

Please do open a pull request.
I noticed that the js code you linked to, does not exactly follow our style conventions.
If you can understand by looking at existing code - 👍
Otherwise I will make individual comments on the PR.

@M-Zuber
Copy link
Collaborator

M-Zuber commented Dec 8, 2015

Oh, and tests :)

@thinkingmedia
Copy link

No, I wouldn't pull my code. I'd have to rewrite it but it shouldn't take long.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants