Skip to content

Commit 547374d

Browse files
committed
Fixed #394
* I think the current README has already described what the tool can do. I created a new "Introduction" header to separate and put the toolkit description from the previous "Build and tests status"
1 parent df6bd28 commit 547374d

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

README.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,8 @@
11
AboutCode Toolkit
22
=================
33

4-
Build and tests status
5-
----------------------
6-
7-
+-------+-----------------+--------------+
8-
|Branch | **Linux/macOS** | **Windows** |
9-
+=======+=================+==============+
10-
|Master | |master-posix| | |master-win| |
11-
+-------+-----------------+--------------+
12-
|Develop| |devel-posix| | |devel-win| |
13-
+-------+-----------------+--------------+
14-
15-
4+
Introduction
5+
------------
166
The AboutCode Toolkit and ABOUT files provide a simple way to document the
177
origin, license, usage and other important or interesting information about
188
third-party software components that you use in your project.
@@ -35,6 +25,18 @@ This version of the AboutCode Toolkit follows the ABOUT specification version 3.
3525
https://github.com/nexB/aboutcode-toolkit/blob/develop/SPECIFICATION.rst
3626

3727

28+
Build and tests status
29+
----------------------
30+
31+
+-------+-----------------+--------------+
32+
|Branch | **Linux/macOS** | **Windows** |
33+
+=======+=================+==============+
34+
|Master | |master-posix| | |master-win| |
35+
+-------+-----------------+--------------+
36+
|Develop| |devel-posix| | |devel-win| |
37+
+-------+-----------------+--------------+
38+
39+
3840
REQUIREMENTS
3941
------------
4042
The AboutCode Toolkit is tested with Python 2.7 and 3.6 on Linux, Mac and Windows.

docs/CHANGELOG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Release 4.0.1
33

44
* Declare to follow SemVer for versioning schema
5-
* Update REFERENCE.rst
5+
* Update REFERENCE.rst and README.rst
66

77

88
2019-10-09

0 commit comments

Comments
 (0)