Skip to content

Commit 3301074

Browse files
committed
Change the name to FOSSLight Source Scanner
1 parent 13d7425 commit 3301074

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

โ€ŽREADME.mdโ€Ž

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ SPDX-License-Identifier: Apache-2.0
88
</a>
99
</p>
1010

11-
# FOSSLight Source
11+
# FOSSLight Source Scanner
1212

13-
<img src="https://img.shields.io/pypi/l/fosslight_source" alt="FOSSLight Source is released under the Apache-2.0 License." /> <img src="https://img.shields.io/pypi/v/fosslight_source" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_source" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source)
13+
<img src="https://img.shields.io/pypi/l/fosslight_source" alt="FOSSLight Source Scanner is released under the Apache-2.0 License." /> <img src="https://img.shields.io/pypi/v/fosslight_source" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_source" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source)
1414
</p>
1515

1616
```note
1717
Detect the license for the source code.
1818
Use Source Code Scanner and process the scanner results.
1919
```
2020

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.
2222

2323

2424
[sc]: https://github.com/nexB/scancode-toolkit
@@ -35,7 +35,7 @@ Use Source Code Scanner and process the scanner results.
3535

3636
## ๐Ÿ“‹ Prerequisite
3737

38-
FOSSLight Source needs a Python 3.6+.
38+
FOSSLight Source Scanner needs a Python 3.6+.
3939
For windows, you need to install [Microsoft Visual C++ Build Tools][ms_build].
4040

4141
[ms_build]: https://visualstudio.microsoft.com/vs/older-downloads/
@@ -50,7 +50,7 @@ $ pip3 install fosslight_source
5050

5151
## ๐Ÿš€ How to run
5252

53-
There are two commands for FOSSLight Scanner.
53+
There are two commands for FOSSLight Source Scanner.
5454

5555
### 1. fosslight_source
5656
After executing ScanCode, the source code scanner, print the FOSSLight Report.
@@ -92,8 +92,8 @@ $ tree
9292
โ””โ”€โ”€ fosslight_src_log_2021-05-03_00-39-49.txt
9393
9494
```
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)
9797
- fosslight_src_log_[datetime].txt : The execution log.
9898
- scancode_[datetime].json : The ScanCode result in case of -j option.
9999

@@ -106,6 +106,6 @@ Please report any ideas or bugs to improve by creating an issue in [Git Reposito
106106

107107
## ๐Ÿ“„ License
108108

109-
FOSSLight Source is Apache-2.0, as found in the [LICENSE][l] file.
109+
FOSSLight Source Scanner is Apache-2.0, as found in the [LICENSE][l] file.
110110

111111
[l]: https://github.com/fosslight/fosslight_source/blob/main/LICENSE

โ€Ždocs/README_Kor.mdโ€Ž

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
</a>
55
</p>
66

7-
# FOSSLight Source
7+
# FOSSLight Source Scanner
88

99
<img src="https://img.shields.io/pypi/l/fosslight_source" alt="FOSSLight Source is released under the Apache-2.0 License." /> <img src="https://img.shields.io/pypi/v/fosslight_source" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_source" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source)
1010
</p>
@@ -14,7 +14,7 @@ Source Code์˜ License๋ฅผ ๊ฒ€์ถœํ•ฉ๋‹ˆ๋‹ค
1414
Source Code ์Šค์บ๋„ˆ๋ฅผ ์ด์šฉํ•˜๊ณ  ๊ฒฐ๊ณผ๋ฅผ ๊ฐ€๊ณตํ•ฉ๋‹ˆ๋‹ค
1515
```
1616

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 ํ˜•ํƒœ๋กœ ์ถœ๋ ฅ๋ฉ๋‹ˆ๋‹ค.
1818

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

@@ -30,22 +30,22 @@ Source Code ์Šค์บ๋„ˆ๋ฅผ ์ด์šฉํ•˜๊ณ  ๊ฒฐ๊ณผ๋ฅผ ๊ฐ€๊ณตํ•ฉ๋‹ˆ๋‹ค
3030

3131
## ๐Ÿ“‹ Prerequisite
3232

33-
FOSSLight Source๋Š” Python 3.6+ ๊ธฐ๋ฐ˜์—์„œ ๋™์ž‘ํ•ฉ๋‹ˆ๋‹ค..
33+
FOSSLight Source Scanner๋Š” Python 3.6+ ๊ธฐ๋ฐ˜์—์„œ ๋™์ž‘ํ•ฉ๋‹ˆ๋‹ค..
3434
Windows์˜ ๊ฒฝ์šฐ [Microsoft Visual C++ Build Tools][ms_build]๋ฅผ ์ถ”๊ฐ€๋กœ ์„ค์น˜ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
3535

3636
[ms_build]: https://visualstudio.microsoft.com/vs/older-downloads/
3737

3838
## ๐ŸŽ‰ How to install
3939

40-
FOSSLight Source๋Š” pip3๋ฅผ ์ด์šฉํ•˜์—ฌ ์„ค์น˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. [python 3.6 + virtualenv](Guide_virtualenv_Kor.md) ํ™˜๊ฒฝ์—์„œ ์„ค์น˜ํ•  ๊ฒƒ์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.
40+
FOSSLight Source Scanner๋Š” pip3๋ฅผ ์ด์šฉํ•˜์—ฌ ์„ค์น˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. [python 3.6 + virtualenv](Guide_virtualenv_Kor.md) ํ™˜๊ฒฝ์—์„œ ์„ค์น˜ํ•  ๊ฒƒ์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.
4141

4242
```
4343
$ pip3 install fosslight_source
4444
```
4545

4646
## ๐Ÿš€ How to run
4747

48-
FOSSLight Scanner์—๋Š” ํ•˜๊ธฐ ๋‘ ๊ฐ€์ง€ ๋ช…๋ น์–ด๊ฐ€ ์žˆ์Šต๋‹ˆ๋‹ค.
48+
FOSSLight Source Scanner์—๋Š” ํ•˜๊ธฐ ๋‘ ๊ฐ€์ง€ ๋ช…๋ น์–ด๊ฐ€ ์žˆ์Šต๋‹ˆ๋‹ค.
4949

5050
### 1. fosslight_source
5151
Source Code ๋ถ„์„์„ ์‹คํ–‰ํ•œ ํ›„ FOSSLight Report ํ˜•์‹์œผ๋กœ ์ถœ๋ ฅํ•ฉ๋‹ˆ๋‹ค.
@@ -94,12 +94,12 @@ $ tree
9494

9595
## ๐Ÿ‘ How to report issue
9696

97-
๊ฐœ์„  ์‚ฌํ•ญ์ด๋‚˜ ๋ฒ„๊ทธ๋Š” [Git Repository][repo]์— ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•˜์—ฌ ๋ฆฌํฌํŠธํ•ด์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. ์ด์Šˆ ๋ฆฌํฌํŠธ๋Š” FOSSLight Scanner ์—…๊ทธ๋ ˆ์ด๋“œ์— ๋งŽ์€ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค.
97+
๊ฐœ์„  ์‚ฌํ•ญ์ด๋‚˜ ๋ฒ„๊ทธ๋Š” [Git Repository][repo]์— ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•˜์—ฌ ๋ฆฌํฌํŠธํ•ด์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. ์ด์Šˆ ๋ฆฌํฌํŠธ๋Š” FOSSLight Source Scanner ์—…๊ทธ๋ ˆ์ด๋“œ์— ๋งŽ์€ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค.
9898

9999
[repo]: https://github.com/fosslight/fosslight_source/issues
100100

101101
## ๐Ÿ“„ License
102102

103-
FOSSLight Source๋Š” Apache-2.0์ž…๋‹ˆ๋‹ค. License ์›๋ฌธ ํŒŒ์ผ [LICENSE][l]๋ฅผ ์ฐธ๊ณ ํ•˜์‹ญ์‹œ์˜ค.
103+
FOSSLight Source Scanner๋Š” Apache-2.0์ž…๋‹ˆ๋‹ค. License ์›๋ฌธ ํŒŒ์ผ [LICENSE][l]๋ฅผ ์ฐธ๊ณ ํ•˜์‹ญ์‹œ์˜ค.
104104

105105
[l]: https://github.com/fosslight/fosslight_source/blob/main/LICENSE

โ€Žsetup.pyโ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
version='1.4.8',
1818
package_dir={"": "src"},
1919
packages=find_packages(where='src'),
20-
description='FOSSLight Source',
20+
description='FOSSLight Source Scanner',
2121
long_description=readme,
2222
long_description_content_type='text/markdown',
2323
license='Apache-2.0',

0 commit comments

Comments
ย (0)