Skip to content

Commit 67a71e8

Browse files
committed
Replace the guide file with a link
1 parent ec72d5f commit 67a71e8

File tree

3 files changed

+8
-181
lines changed

3 files changed

+8
-181
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 8 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ Copyright (c) 2021 LG Electronics
33
SPDX-License-Identifier: Apache-2.0
44
-->
55
<p align='right'>
6-
<a href="https://github.com/fosslight/fosslight_source_scanner/blob/main/docs/README_Kor.md">
6+
<a href="https://fosslight.org/fosslight-guide/scanner/1_source.html">
77
[Korean]
88
</a>
99
</p>
1010

1111
# FOSSLight Source Scanner
1212

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_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)
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_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner) [![Guide](http://img.shields.io/badge/-doc-blue?style=flat-square&logo=github&link=https://fosslight.org/fosslight-guide-en/scanner/1_source.html)](https://fosslight.org/fosslight-guide-en/scanner/1_source.html)
1414
</p>
1515

1616
```note
@@ -23,86 +23,18 @@ Use Source Code Scanner and process the scanner results.
2323

2424
[sc]: https://github.com/nexB/scancode-toolkit
2525

26-
## Contents
2726

28-
- [Prerequisite](#-prerequisite)
29-
- [How to install](#-how-to-install)
30-
- [How to run](#-how-to-run)
31-
- [Result](#-result)
32-
- [How to report issue](#-how-to-report-issue)
33-
- [License](#-license)
27+
## πŸ“– User Guide
3428

29+
We describe the user guide in the FOSSLight guide page.
30+
Please see the [**User Guide**](https://fosslight.org/fosslight-guide-en/scanner/1_source.html) for more information on how to install and run it.
3531

36-
## πŸ“‹ Prerequisite
3732

38-
FOSSLight Source Scanner needs a Python 3.6+.
39-
For windows, you need to install [Microsoft Visual C++ Build Tools][ms_build].
33+
## πŸ‘ Contributing Guide
4034

41-
[ms_build]: https://visualstudio.microsoft.com/vs/older-downloads/
35+
We always welcome your contributions.
36+
Please see the [CONTRIBUTING guide](https://fosslight.org/fosslight-guide-en/learn/1_contribution.html) for how to contribute.
4237

43-
## πŸŽ‰ How to install
44-
45-
It can be installed using pip3. It is recommended to install it in the [python 3.6 + virtualenv](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html) environment.
46-
47-
```
48-
$ pip3 install fosslight_source
49-
```
50-
51-
## πŸš€ How to run
52-
53-
There are two commands for FOSSLight Source Scanner.
54-
55-
### 1. fosslight_source
56-
After executing ScanCode, the source code scanner, print the FOSSLight Report.
57-
58-
| Parameter | Argument | Description |
59-
| ------------- | ------------- | ------------- |
60-
| h | None | Print help message. |
61-
| p | String | Path to detect source. |
62-
| j | None | As an output, the result of executing ScanCode in json format other than FOSSLight Report is additionally generated. |
63-
| o | String | Output file name without file extension. |
64-
65-
#### Ex. Print result to FOSSLight Report and json file
66-
```
67-
$ fosslight_source -p /home/source_path -j
68-
```
69-
70-
### 2. fosslight_convert
71-
Converts the result of executing ScanCode in json format into FOSSLight Report format.
72-
73-
| Parameter | Argument | Description |
74-
| ------------- | ------------- | ------------- |
75-
| h | None | Print help message. |
76-
| p | String | Path of ScanCode json files. |
77-
| o | String | Output file name without file extension. |
78-
79-
#### Ex. Converting scancode json result to FOSSLight report
80-
```
81-
$ fosslight_convert -p /home/jsonfile_dir
82-
```
83-
84-
## πŸ“ Result
85-
86-
```
87-
$ tree
88-
.
89-
β”œβ”€β”€ FOSSLight-Report_2021-05-03_00-39-49.csv
90-
β”œβ”€β”€ FOSSLight-Report_2021-05-03_00-39-49.xlsx
91-
β”œβ”€β”€ scancode_2021-05-03_00-39-49.json
92-
└── fosslight_src_log_2021-05-03_00-39-49.txt
93-
94-
```
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-
- fosslight_src_log_[datetime].txt : The execution log.
98-
- scancode_[datetime].json : The ScanCode result in case of -j option.
99-
100-
101-
## πŸ‘ How to report issue
102-
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.
104-
105-
[repo]: https://github.com/fosslight/fosslight_source_scanner/issues
10638

10739
## πŸ“„ License
10840

β€Ždocs/README_Kor.mdβ€Ž

Lines changed: 0 additions & 105 deletions
This file was deleted.
-11.4 KB
Binary file not shown.

0 commit comments

Comments
Β (0)