Skip to content

Commit 3a6bde0

Browse files
committed
Update README
1 parent 927f7f3 commit 3a6bde0

File tree

2 files changed

+30
-32
lines changed

2 files changed

+30
-32
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
</a>
55
</p>
66
<p align="center">
7-
<strong>Analyze the license for the source code.</strong><br>
8-
Use Source Code Scanner to extract copyright text and license text in the file.
7+
<strong>Detect the license for the source code.</strong><br>
8+
Use Source Code Scanner to detect copyright text and license text in the file.
99
</p>
1010

1111
<p align="center">
@@ -14,7 +14,7 @@
1414
<img src="https://img.shields.io/badge/python-3.6+-blue.svg" />
1515
</p>
1616

17-
**FOSSLight Source** uses [ScanCode][sc], a source code analysis tool, to extract 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 ScanCode execution result. And remove sentences such as "-only" and "-old-style" from the license name to be printed. The output result is generated in Excel format.
17+
**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.
1818

1919
[sc]: https://github.com/nexB/scancode-toolkit
2020

@@ -46,31 +46,31 @@ $ pip3 install fosslight_source
4646
## 🚀 How to run
4747

4848
There are two commands for FOSSLight Scanner.
49-
- The first is **fosslight_source**, a command that executes source code analysis and outputs OSS Report.
50-
- The second command is **fosslight_convert** that converts the result of executing ScanCode in json format into OSS Report format.
5149

52-
### 1. Parameter of fosslight_source
50+
### 1. fosslight_source
51+
After executing ScanCode, the source code scanner, print the OSS Report.
52+
5353
| Parameter | Argument | Description |
5454
| ------------- | ------------- | ------------- |
5555
| h | None | Print help message. |
56-
| p | String | Path to analyze source. |
56+
| p | String | Path to detect source. |
5757
| j | None | As an output, the result of executing ScanCode in json format other than OSS Report is additionally generated. |
5858
| o | String | Output file name without file extension. |
5959

60-
### 2. Parameter of fosslight_convert
60+
#### Ex. Print result to OSS Report and json file
61+
```
62+
$ fosslight_source -p /home/source_path -j
63+
```
64+
65+
### 2. fosslight_convert
66+
Converts the result of executing ScanCode in json format into OSS Report format.
6167
| Parameter | Argument | Description |
6268
| ------------- | ------------- | ------------- |
6369
| h | None | Print help message. |
6470
| p | String | Path of ScanCode json files. |
6571
| o | String | Output file name without file extension. |
6672

67-
68-
### Ex 1. Print result to OSS Report and json file
69-
```
70-
$ fosslight_source -p /home/source_path -j
71-
```
72-
73-
### Ex 2. Converting scancode json result to OSS report
73+
#### Ex. Converting scancode json result to OSS report
7474
```
7575
$ fosslight_convert -p /home/jsonfile_dir
7676
```
@@ -86,10 +86,10 @@ $ tree
8686
└── scancode_2021-03-21_20-44-34.json
8787
8888
```
89-
- OSS_Report-[datetime].xlsx : OSS Report format file that outputs source code analysis.
89+
- OSS_Report-[datetime].xlsx : FOSSLight Source result in OSS Report format.
9090
- result_[datetime].csv : Excluding windows, this is the result of outputting the OSS Report in csv format.
91-
- scancode_[datetime].json : This is the ScanCode execution result that is generated only when the -j option is given.
9291
- fosslight_src_log_[datetime].txt: This is the file where the execution log is saved.
92+
- scancode_[datetime].json : This is the ScanCode result when the -j option is given with the fosslight_source command.
9393

9494

9595
## 👏 How to report issue

docs/README_Kor.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
</a>
55
</p>
66
<p align="center">
7-
<strong>Source Code의 License를 분석합니다</strong><br>
8-
Source Code 스캐너를 이용하여 파일 안에 포함된 Copyright과 License 문구를 추출합니다.
7+
<strong>Source Code의 License를 검출합니다</strong><br>
8+
Source Code 스캐너를 이용하여 파일 안에 포함된 Copyright과 License 문구를 검출합니다.
99
</p>
1010

1111
<p align="center">
@@ -14,7 +14,7 @@
1414
<img src="https://img.shields.io/badge/python-3.6+-blue.svg" />
1515
</p>
1616

17-
**FOSSLight Source** 소스 코드 스캐너인 [ScanCode][sc]를 이용하여, 파일 안에 포함된 Copyright과 License 문구를 추출합니다. Build Script, Binary, Directory, 특정 Directory (ex-test) 안의 파일은 분석 결과에서 제외시킵니다. 그리고 License 이름에서 "-only", "-old-style"와 같은 문구를 제거합니다. 분석 결과는 Excel 형태로 출력됩니다.
17+
**FOSSLight Source** 소스 코드 스캐너인 [ScanCode][sc]를 이용하여, 파일 안에 포함된 Copyright과 License 문구를 검출합니다. Build Script, Binary, Directory, 특정 Directory (ex-test) 안의 파일을 제외시킵니다. 그리고 License 이름에서 "-only", "-old-style"와 같은 문구를 제거합니다. 결과는 Excel 형태로 출력됩니다.
1818

1919
[sc]: https://github.com/nexB/scancode-toolkit
2020

@@ -46,31 +46,29 @@ $ pip3 install fosslight_source
4646
## 🚀 How to run
4747

4848
FOSSLight Scanner에는 하기 두 가지 명령어가 있습니다.
49-
- **fosslight_source** : Source Code 분석을 실행한 후 OSS Report 형식으로 출력.
50-
- **fosslight_convert** : json형태인 ScanCode 결과를 OSS Report 형식으로 변환.
5149

52-
### 1. Parameter of fosslight_source
50+
### 1. fosslight_source
51+
Source Code 분석을 실행한 후 OSS Report 형식으로 출력합니다.
5352
| Parameter | Argument | Description |
5453
| ------------- | ------------- | ------------- |
5554
| h | None | Print help message. |
5655
| p | String | Path to analyze source. |
5756
| j | None | As an output, the result of executing ScanCode in json format other than OSS Report is additionally generated. |
5857
| o | String | Output file name without file extension. |
5958

60-
### 2. Parameter of fosslight_convert
59+
#### Ex. Source Code 분석 후 OSS Report와 json 형태의 ScanCode 결과 출력
60+
```
61+
$ fosslight_source -p /home/source_path -j
62+
```
63+
### 2. fosslight_convert
64+
json형태인 ScanCode 결과를 OSS Report 형식으로 변환합니다.
6165
| Parameter | Argument | Description |
6266
| ------------- | ------------- | ------------- |
6367
| h | None | Print help message. |
6468
| p | String | Path of ScanCode json files. |
6569
| o | String | Output file name without file extension. |
66-
67-
68-
### Ex 1. Source Code 분석 후 OSS Report와 json 형태의 ScanCode 결과 출력
69-
```
70-
$ fosslight_source -p /home/source_path -j
71-
```
7270

73-
### Ex 2. json 형태의 ScanCode 결과를 OSS Report 형식으로 변환
71+
#### Ex. json 형태의 ScanCode 결과를 OSS Report 형식으로 변환
7472
```
7573
$ fosslight_convert -p /home/jsonfile_dir
7674
```
@@ -88,8 +86,8 @@ $ tree
8886
```
8987
- OSS_Report-[datetime].xlsx : OSS Report형태의 Source Code 분석 결과
9088
- result_[datetime].csv : OSS Report를 csv로 출력한 결과 (Windows 제외)
91-
- scancode_[datetime].json : ScanCode 실행 결과 (-j 옵션이 포함된 경우에만 생성)
9289
- fosslight_src_log_[datetime].txt: 실행 로그가 저장된 파일
90+
- scancode_[datetime].json : ScanCode 실행 결과 (fosslight_source명령어에 -j 옵션이 포함된 경우에만 생성)
9391

9492

9593
## 👏 How to report issue

0 commit comments

Comments
 (0)