Browse Source

Added README.md

Johann Schmitz 3 years ago
parent
commit
dee6505a62
Signed by: Johann Schmitz <johann@j-schmitz.net> GPG Key ID: A084064277C501ED
1 changed files with 38 additions and 0 deletions
  1. 38
    0
      README.md

+ 38
- 0
README.md View File

@@ -0,0 +1,38 @@
1
+Tool to automatically detect FLOSS licenses.
2
+
3
+`license-finder` needs a folder with license files (defaults to `/usr/portage/licenses` for easy use on Gentoo).
4
+
5
+## Usage
6
+
7
+    license-finder <directory>
8
+
9
+Other options
10
+
11
+    usage: license-finder [-h] [--licenses-dir LICENSES_DIR]
12
+                          [--min-ratio MIN_RATIO] [-n N]
13
+                          files_or_dirs [files_or_dirs ...]
14
+    
15
+    positional arguments:
16
+      files_or_dirs
17
+    
18
+    optional arguments:
19
+      -h, --help            show this help message and exit
20
+      --licenses-dir LICENSES_DIR
21
+                            Directory to look for licenses (default:
22
+                            /usr/portage/licenses)
23
+      --min-ratio MIN_RATIO
24
+                            Minimum ratio to consider the file as a match
25
+                            (default: 0.8)
26
+      -n N                  Show at most x matching licenses
27
+
28
+
29
+Example output:
30
+
31
+    /tmp/license-finder/LICENSE.txt:
32
+    ----------------------------------------------
33
+      97.791 %: /usr/portage/licenses/GPL-2 (+0 -0 ~4)
34
+      96.934 %: /usr/portage/licenses/GPL-2-with-font-exception (+0 -1 ~4)
35
+      96.093 %: /usr/portage/licenses/GPL-2-with-linking-exception (+0 -1 ~4)
36
+      95.954 %: /usr/portage/licenses/GPL-2-with-exceptions (+0 -1 ~4)
37
+      86.207 %: /usr/portage/licenses/kvirc (+0 -1 ~3)
38
+