Skip to content

Commit 2e0b2b0

Browse files
authored
Merge pull request #74 from fosslight/develop
Update the README to add 'how it works without Internet'
2 parents 7442413 + d81a927 commit 2e0b2b0

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

β€ŽREADME.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,19 @@ SPDX-License-Identifier: Apache-2.0
44
-->
55
# FOSSLight Dependency Scanner
66

7-
<img src="https://img.shields.io/pypi/l/fosslight_dependency" alt="License" /> <img src="https://img.shields.io/pypi/v/fosslight_dependency" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_dependency" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_dependency_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_dependency_scanner)
7+
<img src="https://img.shields.io/pypi/l/fosslight_dependency" alt="License" /> <a href="https://pypi.org/project/fosslight-dependency/"><img src="https://img.shields.io/pypi/v/fosslight_dependency" alt="Current python package version." /></a> <img src="https://img.shields.io/pypi/pyversions/fosslight_dependency" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_dependency_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_dependency_scanner)
8+
89

910
## πŸ’‘ Introduction
1011

1112
This is the tool that supports the analysis of dependencies for multiple package managers. It detects the manifest file of package managers automatically and analyzes the dependencies with using open source tools. Then, it generates the report file that contains OSS information of dependencies.
1213

13-
Currently, it supports the following package managers.
1414

15-
- [Gradle](https://gradle.org/) (Java)
16-
- [Maven](http://maven.apache.org/) (Java)
17-
- [NPM](https://www.npmjs.com/) (Node.js)
18-
- [PIP](https://pip.pypa.io/) (Python)
19-
- [Pub](https://pub.dev/) (Dart with flutter)
20-
- [Cocoapods](https://cocoapods.org/) (Swift/Obj-C)
21-
- [Swift](https://swift.org/package-manager/) (Swift)
22-
- [Carthage](https://github.com/Carthage/Carthage) (Swift/Obj-C)
23-
- [Go](https://pkg.go.dev/) (Go)
15+
## πŸ“– User Guide
16+
17+
We describe the user guide in the [**FOSSLight Guide page**](https://fosslight.org/fosslight-guide-en/scanner/3_dependency.html).
18+
In this user guide, you can see how to install the FOSSLight Dependency Scanner and how to set up the prerequisite step and run it according to the package manager of your project. Also, you can check the results of the FOSSLight Dependency Scanner.
19+
2420

2521
## 🧐 How to analyze the dependencies
2622

@@ -38,16 +34,27 @@ Each package manager uses the results of the following software:
3834
Because we utilizes the different open source software to analyze the dependencies of each package manager, you need to set up the **Prerequisite** steps in [User guide](https://fosslight.org/fosslight-guide-en/scanner/3_dependency.html#-prerequisite) according to package manager to analyze.
3935

4036

41-
## πŸ“– User Guide
37+
### 🌐 How it works without Internet
38+
| Package manager | Can it work without Internet? |
39+
|-----------------|-------------------------------------------|
40+
| [Gradle](https://gradle.org/) (Java) | Yes, if the following conditions are met. <br /> - installed the plugin([com.github.hierynomus.license '0.16.1'](https://plugins.gradle.org/plugin/com.github.hierynomus.license/0.16.1)) <br /> - installed the packages of the project |
41+
| [Maven](http://maven.apache.org/) (Java) | Yes, if the following conditions are met. <br /> - installed the plugin([org.codehaus.mojo:license-maven-plugin](https://search.maven.org/artifact/org.codehaus.mojo/license-maven-plugin/2.0.0/)) <br /> - installed the packages of the project |
42+
| [NPM](https://www.npmjs.com/) (Node.js) | Yes, if the following conditions are met. <br /> - installed the plugin([license-checker](https://www.npmjs.com/package/license-checker)) <br /> - installed the packages of the project (in other words, generated the node_modules directory) |
43+
| [PIP](https://pip.pypa.io/) (Python) | No, it can't. |
44+
| [Android(gradle)](https://gradle.org/) (Android application) | Yes, if the following conditions are met. <br /> - installed the plugin([android-dependency-scanning](https://search.maven.org/artifact/org.fosslight/android-dependency-scanning/1.0.0/jar)) <br /> - installed the packages of the project |
45+
| [Pub](https://pub.dev/) (Dart with flutter) | Yes, if the following conditions are met. <br /> - installed the plugin([flutter_oss_licenses](https://pub.dev/packages/flutter_oss_licenses)) <br /> - installed the packages of the project |
46+
| [Cocoapods](https://cocoapods.org/) (Swift/Obj-C) | Yes, if the following conditions are met. <br /> - installed the packages of the project <br /> - enable to run the command (pod spec which --regex {package name} ) |
47+
| [Swift](https://swift.org/package-manager/) (Swift) | No, it can't. |
48+
| [Carthage](https://github.com/Carthage/Carthage) (Swift/Obj-C) | Yes, if the following conditions are met. <br /> - installed the packages of the project (in other words, downloadeded the sources in 'Carthgae/Checkouts' directory). |
49+
| [Go](https://pkg.go.dev/) (Go) | No, it can't. |
4250

43-
We describe the user guide in the FOSSLight guide page.
44-
Please see the [**User Guide**](https://fosslight.org/fosslight-guide-en/scanner/3_dependency.html) for more information on how to install and run it.
4551

4652
## πŸ‘ Contributing Guide
4753

4854
We always welcome your contributions.
4955
Please see the [CONTRIBUTING guide](https://github.com/fosslight/fosslight_dependency_scanner/blob/main/CONTRIBUTING.md) for how to contribute.
5056

57+
5158
## πŸ“„ License
5259

5360
Copyright (c) 2020 LG Electronics, Inc.

0 commit comments

Comments
Β (0)