Skip to content

Commit 2ceb2f4

Browse files
committed
Update documents
1 parent 2a69d54 commit 2ceb2f4

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/user-guide.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,18 @@ $ fosslight_reuse report -f src/oss-pkg-info.yaml,main/setting.yml
127127

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

133133
## 📁 Result
134134
If an output file name is specified with -o, a result file is created with that name.
135135
- FOSSLight-Report_[datetime].xlsx : When the oss-pkg-info.yaml file is converted to OSS-Report.xlsx
136-
- oss-pkg-info_[datetime].yaml : FOSSLight-Report.xlsx is converted to oss-pkg-info.yaml.
136+
- oss-pkg-info_[datetime].yaml : FOSSLight-Report.xlsx is converted to oss-pkg-info.yaml.
137+
138+
139+
## 🚀 How to run - report (Run as executable. Only for windows.)
140+
1. Download the executable from [fosslight_reuse release][release]
141+
2. Run the executable from the path where FOSSLight-Report*.xlsx or oss-pkg-info.yaml is located.
142+
3. If oss-pkg-info.yaml exists, it will be converted to FOSSLight-Report.xlsx, and if FOSSLight-Report*.xlsx is found, it will be converted to oss-pkg-info.yaml.
143+
144+
[release]: https://github.com/fosslight/fosslight_reuse/releases

0 commit comments

Comments
 (0)