Skip to content

Commit 22ed935

Browse files
committed
Update user guide
1 parent 34c025e commit 22ed935

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/user-guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It uses [reuse-tool][ret] to check whether the source code's copyright and licen
1212
1. `lint` --- Check whether the source code's copyright and license writing rules are complied with.
1313
2. `report` --- Convert oss-pkg-info.yaml to FOSSLight-Report.xlsx and vice versa.
1414
- It converts oss-pkg-info.yaml to SRC Sheet of FOSSLight Report or
15-
- BIN (Android) and BOM Sheet of OSS Report to oss-pkg-info.yaml.
15+
- BIN (Android) and BOM Sheet of FOSSLight Report to oss-pkg-info.yaml.
1616

1717
## 🎉 How to install
1818

@@ -52,12 +52,12 @@ $ fosslight_reuse lint -p /home/test/ -f "notice/sample.py,src/init.py"
5252
3-1. When running on a project basis. (without -f parameter)
5353
- If there is no ./reuse/dep5 file in the Root Path, it is created.
5454
- If it already exists, copy it to bk file and append the default config value to the existing dep file.
55-
- By creating dep5 files, exclude binary or .json, venv */*, node_modules/*,. */* from reuse.
55+
- By creating the dep5 file, exclude binary or .json, venv*/*, node_modules/*,. */* from reuse.
5656
- Run the reuse lint
5757
If the OSS Package Information file exists, the list of missing license files is not printed.
58-
- Rollback dep5-related file creation part.
58+
- Remove dep5-related file.
5959

60-
3-2. When executing in file unit (with -f option)
60+
3-2. When executing in file unit (with -f parameter)
6161
- Print the copyright text and license text extraction by file.
6262
- However, if the file does not exist or the file is binary or .json, copyright text and license text are not printed.
6363

@@ -112,9 +112,9 @@ $ fosslight_reuse report
112112
| p | [path_to_check] | O | Convert all oss-pkg-info*.yaml or oss-pkg-info*.yml in the path recursively |
113113
| h | None | X | Print help message. |
114114
| o | [result_file_name] | X | Output file name |
115-
| f | [file1,file2,...] | X | 1. Yaml files are converted as OSS Report (separated by, if multiple) <br> ex) -f src/oss-pkg-info.yaml,main/setting.yml 2. OSS Report file to be converted to oss-pkg-info.yaml. |
115+
| f | [file1,file2,...] | X | 1. Yaml files are converted as FOSSLight Report (separated by, if multiple) <br> ex) -f src/oss-pkg-info.yaml,main/setting.yml 2. FOSSLight Report file to be converted to oss-pkg-info.yaml. |
116116

117-
### Ex 1. Convert oss-pkg-info.yaml file to OSS Report.
117+
### Ex 1. Convert oss-pkg-info.yaml file to FOSSLight Report.
118118
1-1. Convert all oss-pkg-info*.yaml or oss-pkg-info*.yml in the path recursively.
119119
```
120120
$ fosslight_reuse report -p /home/test/source
@@ -125,7 +125,7 @@ $ fosslight_reuse report -p /home/test/source
125125
$ fosslight_reuse report -f src/oss-pkg-info.yaml,main/setting.yml
126126
```
127127

128-
### Ex 2. Convert OSS Report to oss-pkg-info.yaml file.
128+
### Ex 2. Convert FOSSLight Report to oss-pkg-info.yaml file.
129129
```
130130
$ fosslight_reuse report -f src/FOSSLight-Report.xlsx
131131
```

0 commit comments

Comments
 (0)