diff --git a/README.md b/README.md index b020c97..0d51568 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ SPDX-License-Identifier: Apache-2.0 -->
@@ -53,22 +53,22 @@ $ pip3 install fosslight_source There are two commands for FOSSLight Scanner. ### 1. fosslight_source -After executing ScanCode, the source code scanner, print the OSS Report. +After executing ScanCode, the source code scanner, print the FOSSLight Report. | Parameter | Argument | Description | | ------------- | ------------- | ------------- | | h | None | Print help message. | | p | String | Path to detect source. | -| j | None | As an output, the result of executing ScanCode in json format other than OSS Report is additionally generated. | +| j | None | As an output, the result of executing ScanCode in json format other than FOSSLight Report is additionally generated. | | o | String | Output file name without file extension. | -#### Ex. Print result to OSS Report and json file +#### Ex. Print result to FOSSLight Report and json file ``` $ fosslight_source -p /home/source_path -j ``` ### 2. fosslight_convert -Converts the result of executing ScanCode in json format into OSS Report format. +Converts the result of executing ScanCode in json format into FOSSLight Report format. | Parameter | Argument | Description | | ------------- | ------------- | ------------- | @@ -76,7 +76,7 @@ Converts the result of executing ScanCode in json format into OSS Report format. | p | String | Path of ScanCode json files. | | o | String | Output file name without file extension. | -#### Ex. Converting scancode json result to OSS report +#### Ex. Converting scancode json result to FOSSLight report ``` $ fosslight_convert -p /home/jsonfile_dir ``` @@ -86,14 +86,14 @@ $ fosslight_convert -p /home/jsonfile_dir ``` $ tree . -├── OSS-Report_2021-05-03_00-39-49.csv -├── OSS-Report_2021-05-03_00-39-49.xlsx +├── FOSSLight-Report_2021-05-03_00-39-49.csv +├── FOSSLight-Report_2021-05-03_00-39-49.xlsx ├── scancode_2021-05-03_00-39-49.json └── fosslight_src_log_2021-05-03_00-39-49.txt ``` -- OSS-Report_[datetime].xlsx : FOSSLight Source result in OSS Report format. -- OSS-Report_[datetime].csv : FOSSLight Source result in csv format. (Except Windows) +- FOSSLight-Report_[datetime].xlsx : FOSSLight Source result in OSS Report format. +- FOSSLight-Report_[datetime].csv : FOSSLight Source result in csv format. (Except Windows) - fosslight_src_log_[datetime].txt : The execution log. - scancode_[datetime].json : The ScanCode result in case of -j option. diff --git a/docs/README_Kor.md b/docs/README_Kor.md index 1ab819f..3b2d23e 100644 --- a/docs/README_Kor.md +++ b/docs/README_Kor.md @@ -1,6 +1,6 @@ @@ -48,21 +48,21 @@ $ pip3 install fosslight_source FOSSLight Scanner에는 하기 두 가지 명령어가 있습니다. ### 1. fosslight_source -Source Code 분석을 실행한 후 OSS Report 형식으로 출력합니다. +Source Code 분석을 실행한 후 FOSSLight Report 형식으로 출력합니다. | Parameter | Argument | Description | | ------------- | ------------- | ------------- | | h | None | Print help message. | | p | String | Path to analyze source. | -| j | None | As an output, the result of executing ScanCode in json format other than OSS Report is additionally generated. | +| j | None | As an output, the result of executing ScanCode in json format other than FOSSLight Report is additionally generated. | | o | String | Output file name without file extension. | -#### Ex. Source Code 분석 후 OSS Report와 json 형태의 ScanCode 결과 출력 +#### Ex. Source Code 분석 후 FOSSLight Report와 json 형태의 ScanCode 결과 출력 ``` $ fosslight_source -p /home/source_path -j ``` ### 2. fosslight_convert -json형태인 ScanCode 결과를 OSS Report 형식으로 변환합니다. +json형태인 ScanCode 결과를 FOSSLight Report 형식으로 변환합니다. | Parameter | Argument | Description | | ------------- | ------------- | ------------- | @@ -70,7 +70,7 @@ json형태인 ScanCode 결과를 OSS Report 형식으로 변환합니다. | p | String | Path of ScanCode json files. | | o | String | Output file name without file extension. | -#### Ex. json 형태의 ScanCode 결과를 OSS Report 형식으로 변환 +#### Ex. json 형태의 ScanCode 결과를 FOSSLight Report 형식으로 변환 ``` $ fosslight_convert -p /home/jsonfile_dir ``` @@ -80,14 +80,14 @@ $ fosslight_convert -p /home/jsonfile_dir ``` $ tree . -├── OSS-Report_2021-05-03_00-39-49.csv -├── OSS-Report_2021-05-03_00-39-49.xlsx +├── FOSSLight-Report_2021-05-03_00-39-49.csv +├── FOSSLight-Report_2021-05-03_00-39-49.xlsx ├── scancode_2021-05-03_00-39-49.json └── fosslight_src_log_2021-05-03_00-39-49.txt ``` -- OSS-Report_[datetime].xlsx : OSS Report형태의 Source Code 분석 결과 -- OSS-Report_[datetime].csv : OSS Report를 csv로 출력한 결과 (Windows 제외) +- FOSSLight-Report_[datetime].xlsx : FOSSLight Report형태의 Source Code 분석 결과 +- FOSSLight-Report_[datetime].csv : FOSSLight Report를 csv로 출력한 결과 (Windows 제외) - fosslight_src_log_[datetime].txt: 실행 로그가 저장된 파일 - scancode_[datetime].json : ScanCode 실행 결과 (fosslight_source명령어에 -j 옵션이 포함된 경우에만 생성) diff --git a/src/fosslight_source/_help.py b/src/fosslight_source/_help.py index 02b0fad..1335b19 100644 --- a/src/fosslight_source/_help.py +++ b/src/fosslight_source/_help.py @@ -25,7 +25,7 @@ _HELP_MESSAGE_CONVERT = """ Usage: fosslight_convert [option1]