Skip to content

Commit acc6a1a

Browse files
committed
Update docs
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 2232773 commit acc6a1a

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

docs/CHANGELOG.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
2018-10-23
2+
3+
Release 3.2.2
4+
5+
* Fix the version number
6+
* `name` field is no longer a required field
7+
18
2018-10-22
29

310
Release 3.2.1

docs/UsingAboutCodetoDocumentYourSoftwareAssets.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ You should start with a software inventory of your codebase in spreadsheet forma
6363
<tr>
6464
<td>name</td>
6565
<td>Component name</td>
66-
<td>Mandatory</td>
66+
<td>Optional</td>
6767
</tr>
6868
<tr>
6969
<td>about_resource</td>
@@ -232,10 +232,8 @@ You can customize your copy of MAPPING.CONFIG to recognize your own software inv
232232
# Essential Fields
233233
about_file_path: Directory/Filename
234234
235-
# Mandatory Fields
236-
name: Component
237-
238235
# Optional Fields
236+
name: Component
239237
version: Confirmed Version
240238
copyright: Confirmed Copyright
241239
@@ -247,7 +245,7 @@ You can customize your copy of MAPPING.CONFIG to recognize your own software inv
247245

248246
When your software inventory is ready, you can save it as a .csv file, and use it as input to run gen to generate your AboutCode Toolkit files. The official gen parameters are defined here:
249247

250-
* [https://github.com/nexB/aboutcode-toolkit/blob/develop/USAGE.rst](https://github.com/nexB/aboutcode-toolkit/blob/develop/USAGE.rst)
248+
* [https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst](https://github.com/nexB/aboutcode-toolkit/blob/develop/REFERENCE.rst)
251249

252250
Here is an example of a gen command:
253251

85 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)