Skip to content

Commit 7cdfa97

Browse files
committed
Update wording for the README.rst
1 parent cc33783 commit 7cdfa97

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.rst

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ USAGE
7474
-----
7575
The ABOUT tool command syntax is:
7676

77-
about.py
77+
**about.py**
7878

7979
::
8080

@@ -101,7 +101,7 @@ In this example, the .ABOUT files in the directory /thirdparty_code/ will
101101
be parsed and validated to collect the data they contain. The collected
102102
information will be saved to the CSV file named "thirdparty_about.csv".
103103

104-
genabout.py
104+
**genabout.py**
105105

106106
::
107107

@@ -150,6 +150,42 @@ genabout.py
150150
Example syntax:
151151
genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key'
152152

153+
Example::
154+
155+
$ python genabout.py thirdparty_code.csv /tmp/thirdparty_about/
156+
157+
In this example, the tool will look at the "thirdparty_code.csv" and generate
158+
the .ABOUT files in the directory /tmp/thirdparty_about/.
159+
160+
**genattrib.py**
161+
162+
::
163+
164+
Usage: genattrib.py [options] input_path output_path component_list
165+
166+
Input can be a file or directory.
167+
Output of rendered template must be a file (e.g. .html).
168+
Component List must be a .csv file which has at least an "about_resource" column.
169+
170+
171+
Options:
172+
-h, --help Display help
173+
-v, --version Display current version, license notice, and copyright notice
174+
--overwrite Overwrites the output file if it exists
175+
--verbosity=VERBOSITY
176+
Print more or fewer verbose messages while processing ABOUT files
177+
0 - Do not print any warning or error messages, just a total count (default)
178+
1 - Print error messages
179+
2 - Print error and warning messages
180+
181+
Example::
182+
183+
$ python genattrib.py /tmp/thirdparty_about/ /tmp/thirdparty_attribution/attribution.html thirdparty_code.csv
184+
185+
In this example, the tool will look at the .ABOUT files listed in the "thirdparty_code.csv"
186+
from the /tmp/thirdparty_about/ and then generate the attribution output to
187+
/tmp/thirdparty_attribution/attribution.html
188+
153189

154190
HELP and SUPPORT
155191
----------------

0 commit comments

Comments
 (0)