Skip to content

Commit 5e2f69b

Browse files
dd-jybjk7119
authored andcommitted
move user-guide link to FOSSLight guide
Signed-off-by: Jiyeong Seok <[email protected]> Signed-off-by: Jaekwon Bang <[email protected]>
1 parent 69090f0 commit 5e2f69b

File tree

3 files changed

+16
-541
lines changed

3 files changed

+16
-541
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,24 @@ Currently, it supports the following package managers.
2020
- [Pub](https://pub.dev/) (Dart with flutter)
2121
- [Cocoapods](https://cocoapods.org/) (Swift/Obj-C)
2222

23+
## 🧐 How to analyze the dependencies
24+
25+
FOSSLight Dependency Scanner utilizes the open source software for analyzing each package manager dependencies. We choose the open source software for each package manager that shows not only the direct dependencies but also the transitive dependencies including the information of dependencies such as oss name, oss version and license name.
26+
27+
Each package manager uses the results of the following software:
28+
29+
- NPM : [NPM License Checker](https://github.com/davglass/license-checker)
30+
- Pypi : [pip-licenses](https://github.com/raimon49/pip-licenses)
31+
- Gradle : [License Gradle Plugin](https://github.com/hierynomus/license-gradle-plugin)
32+
- Maven : [license-maven-plugin](https://github.com/mojohaus/license-maven-plugin)
33+
- Pub : [flutter_oss_licenses](https://github.com/espresso3389/flutter_oss_licenses)
34+
35+
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/2_dependency.html) according to package manager to analyze.
36+
2337
## 📖 User Guide
2438

25-
Please see the [**User Guide**](https://github.com/fosslight/fosslight_dependency_scanner/blob/main/docs/user-guide.md) for more information on how to install and run it.
39+
We describe the user guide in the FOSSLight guide page.
40+
Please see the [**User Guide**](https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html) for more information on how to install and run it.
2641

2742
## 👏 Contributing Guide
2843

docs/user-guide.md

Lines changed: 0 additions & 269 deletions
This file was deleted.

0 commit comments

Comments
 (0)