Skip to content

Commit ade3e8a

Browse files
committed
synchronized home.rst file with aboutcode-toolkit readme file
Signed-off-by: Naveen-singla <Naveensingla2001@gmail.com>
1 parent 480ddf3 commit ade3e8a

1 file changed

Lines changed: 28 additions & 6 deletions

File tree

docs/source/aboutcode-toolkit/home.rst

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@ AboutCode Toolkit
22
=================
33

44
Introduction
5-
----------------------
6-
5+
------------
76
The AboutCode Toolkit and ABOUT files provide a simple way to document the
87
origin, license, usage and other important or interesting information about
98
third-party software components that you use in your project.
109

1110
You start by storing ABOUT files (a small YAML formatted text file with field/value pairs)
1211
side-by-side with each of the third-party software components you use.
1312
Each ABOUT file documents origin and license for one software.
14-
For more information on the ABOUT file format, visit http://www.dejacode.org
1513
There are many examples of ABOUT files (valid or invalid) in the testdata/
1614
directory of the whole repository.
1715

@@ -22,7 +20,7 @@ In addition, this tool is able to generate attribution notices and
2220
identify redistributable source code used in your project to help you comply
2321
with open source licenses conditions.
2422

25-
This version of the AboutCode Toolkit follows the ABOUT specification version 3.1.2 at:
23+
This version of the AboutCode Toolkit follows the ABOUT specification version 3.2.1 at:
2624
https://aboutcode-toolkit.readthedocs.io/en/latest/specification.html
2725

2826

@@ -40,7 +38,7 @@ Build and tests status
4038

4139
REQUIREMENTS
4240
------------
43-
The AboutCode Toolkit is tested with Python 2.7 and 3.6 on Linux, Mac and Windows.
41+
The AboutCode Toolkit is tested with Python 3.6.2 or above only on Linux, Mac and Windows.
4442
You will need to install a Python interpreter if you do not have one already
4543
installed.
4644

@@ -67,6 +65,30 @@ or on windows:
6765
configure
6866

6967

68+
Activate the virtualenv
69+
-----------------------
70+
To activate the virtualenv, run (on posix):
71+
source bin/activate
72+
or on windows:
73+
bin\\activate
74+
75+
76+
Deactivate the virtualenv
77+
-------------------------
78+
To deactivate the virtualenv, run (on both posix and windows):
79+
deactivate
80+
81+
82+
VERSIONING SCHEMA
83+
-----------------
84+
Starting at AboutCode version 4.0.0, the AboutCode Toolkit will follow SemVer for the versioning schema.
85+
86+
i.e. MAJOR.MINOR.PATCH format
87+
1. MAJOR version when making incompatible API changes,
88+
2. MINOR version when making functionality in a backwards compatible manner, and
89+
3. PATCH version when making backwards compatible bug fixes.
90+
91+
7092
REFERENCE
7193
---------
7294
See https://github.com/nexB/aboutcode-toolkit/blob/master/REFERENCE.rst for reference
@@ -104,7 +126,7 @@ The AboutCode Toolkit is available through GitHub. For the latest version visit:
104126
HACKING
105127
-------
106128
We accept pull requests provided under the same license as this tool.
107-
You agree to the http://developercertificate.org/
129+
You agree to the http://developercertificate.org/
108130

109131

110132
LICENSE

0 commit comments

Comments
 (0)