You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Hi! I'm really appreciate that you'd like to contribute to this project. Your he
4
4
5
5
## Submitting a pull request
6
6
7
-
1. <aclass="github-button"href="https://github.com/fosslight/fosslight_source/fork"data-icon="octicon-repo-forked"aria-label="Fork fosslight/fosslight_source on GitHub">```Fork```</a> and clone the repository
7
+
1. <aclass="github-button"href="https://github.com/fosslight/fosslight_source_scanner/fork"data-icon="octicon-repo-forked"aria-label="Fork fosslight/fosslight_source_scanner on GitHub">```Fork```</a> and clone the repository
8
8
2. Create a new branch: `git checkout -b my-branch-name`
9
9
3. Make your change and make sure it works properly.
<imgsrc="https://img.shields.io/pypi/l/fosslight_source"alt="FOSSLight Source is released under the Apache-2.0 License." /> <imgsrc="https://img.shields.io/pypi/v/fosslight_source"alt="Current python package version." /> <imgsrc="https://img.shields.io/pypi/pyversions/fosslight_source" /> [](https://api.reuse.software/info/github.com/fosslight/fosslight_source)
13
+
<imgsrc="https://img.shields.io/pypi/l/fosslight_source"alt="FOSSLight Source Scanner is released under the Apache-2.0 License." /> <imgsrc="https://img.shields.io/pypi/v/fosslight_source"alt="Current python package version." /> <imgsrc="https://img.shields.io/pypi/pyversions/fosslight_source" /> [](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)
14
14
</p>
15
15
16
16
```note
17
17
Detect the license for the source code.
18
18
Use Source Code Scanner and process the scanner results.
19
19
```
20
20
21
-
**FOSSLight Source** uses [ScanCode][sc], a source code scanner, to detect the copyright and license phrases contained in the file. Some files (ex- build script), binary files, directory and files in specific directories (ex-test) are excluded from the result. And removes words such as "-only" and "-old-style" from the license name to be printed. The output result is generated in Excel format.
21
+
**FOSSLight Source Scanner** uses [ScanCode][sc], a source code scanner, to detect the copyright and license phrases contained in the file. Some files (ex- build script), binary files, directory and files in specific directories (ex-test) are excluded from the result. And removes words such as "-only" and "-old-style" from the license name to be printed. The output result is generated in Excel format.
22
22
23
23
24
24
[sc]: https://github.com/nexB/scancode-toolkit
@@ -35,22 +35,22 @@ Use Source Code Scanner and process the scanner results.
35
35
36
36
## 📋 Prerequisite
37
37
38
-
FOSSLight Source needs a Python 3.6+.
38
+
FOSSLight Source Scanner needs a Python 3.6+.
39
39
For windows, you need to install [Microsoft Visual C++ Build Tools][ms_build].
It can be installed using pip3. It is recommended to install it in the [python 3.6 + virtualenv](https://github.com/fosslight/fosslight_source/blob/main/docs/Guide_virtualenv.md) environment.
45
+
It can be installed using pip3. It is recommended to install it in the [python 3.6 + virtualenv](https://github.com/fosslight/fosslight_source_scanner/blob/main/docs/Guide_virtualenv.md) environment.
46
46
47
47
```
48
48
$ pip3 install fosslight_source
49
49
```
50
50
51
51
## 🚀 How to run
52
52
53
-
There are two commands for FOSSLight Scanner.
53
+
There are two commands for FOSSLight Source Scanner.
54
54
55
55
### 1. fosslight_source
56
56
After executing ScanCode, the source code scanner, print the FOSSLight Report.
@@ -92,8 +92,8 @@ $ tree
92
92
└── fosslight_src_log_2021-05-03_00-39-49.txt
93
93
94
94
```
95
-
- FOSSLight-Report_[datetime].xlsx : FOSSLight Source result in OSS Report format.
96
-
- FOSSLight-Report_[datetime].csv : FOSSLight Source result in csv format. (Except Windows)
95
+
- FOSSLight-Report_[datetime].xlsx : FOSSLight Source Scanner result in OSS Report format.
96
+
- FOSSLight-Report_[datetime].csv : FOSSLight Source Scanner result in csv format. (Except Windows)
97
97
- fosslight_src_log_[datetime].txt : The execution log.
98
98
- scancode_[datetime].json : The ScanCode result in case of -j option.
99
99
@@ -102,10 +102,10 @@ $ tree
102
102
103
103
Please report any ideas or bugs to improve by creating an issue in [Git Repository][repo]. Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.
<imgsrc="https://img.shields.io/pypi/l/fosslight_source"alt="FOSSLight Source is released under the Apache-2.0 License." /> <imgsrc="https://img.shields.io/pypi/v/fosslight_source"alt="Current python package version." /> <imgsrc="https://img.shields.io/pypi/pyversions/fosslight_source" /> [](https://api.reuse.software/info/github.com/fosslight/fosslight_source)
9
+
<imgsrc="https://img.shields.io/pypi/l/fosslight_source"alt="FOSSLight Source is released under the Apache-2.0 License." /> <imgsrc="https://img.shields.io/pypi/v/fosslight_source"alt="Current python package version." /> <imgsrc="https://img.shields.io/pypi/pyversions/fosslight_source" /> [](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)
10
10
</p>
11
11
12
12
```note
13
13
Source Code의 License를 검출합니다
14
14
Source Code 스캐너를 이용하고 결과를 가공합니다
15
15
```
16
16
17
-
**FOSSLight Source** 소스 코드 스캐너인 [ScanCode][sc]를 이용하여, 파일 안에 포함된 Copyright과 License 문구를 검출합니다. Build Script, Binary, Directory, 특정 Directory (ex-test) 안의 파일을 제외시킵니다. 그리고 License 이름에서 "-only", "-old-style"와 같은 문구를 제거합니다. 결과는 Excel 형태로 출력됩니다.
17
+
**FOSSLight Source Scanner** 소스 코드 스캐너인 [ScanCode][sc]를 이용하여, 파일 안에 포함된 Copyright과 License 문구를 검출합니다. Build Script, Binary, Directory, 특정 Directory (ex-test) 안의 파일을 제외시킵니다. 그리고 License 이름에서 "-only", "-old-style"와 같은 문구를 제거합니다. 결과는 Excel 형태로 출력됩니다.
18
18
19
19
[sc]: https://github.com/nexB/scancode-toolkit
20
20
@@ -30,22 +30,22 @@ Source Code 스캐너를 이용하고 결과를 가공합니다
0 commit comments