Skip to content

Commit c1da697

Browse files
authored
Merge pull request #89 from Naveen-singla/refor3
Refor3
2 parents bb4c85d + ade3e8a commit c1da697

1 file changed

Lines changed: 42 additions & 16 deletions

File tree

docs/source/aboutcode-toolkit/home.rst

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,15 @@
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.
199

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

@@ -31,12 +20,25 @@ In addition, this tool is able to generate attribution notices and
3120
identify redistributable source code used in your project to help you comply
3221
with open source licenses conditions.
3322

34-
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:
3524
https://aboutcode-toolkit.readthedocs.io/en/latest/specification.html
3625

26+
27+
Build and tests status
28+
----------------------
29+
30+
+-------+-----------------+--------------+
31+
|Branch | **Linux/macOS** | **Windows** |
32+
+=======+=================+==============+
33+
|Master | |master-posix| | |master-win| |
34+
+-------+-----------------+--------------+
35+
|Develop| |devel-posix| | |devel-win| |
36+
+-------+-----------------+--------------+
37+
38+
3739
REQUIREMENTS
3840
------------
39-
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.
4042
You will need to install a Python interpreter if you do not have one already
4143
installed.
4244

@@ -63,6 +65,30 @@ or on windows:
6365
configure
6466

6567

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+
6692
REFERENCE
6793
---------
6894
See https://github.com/nexB/aboutcode-toolkit/blob/master/REFERENCE.rst for reference
@@ -100,7 +126,7 @@ The AboutCode Toolkit is available through GitHub. For the latest version visit:
100126
HACKING
101127
-------
102128
We accept pull requests provided under the same license as this tool.
103-
You agree to the http://developercertificate.org/
129+
You agree to the http://developercertificate.org/
104130

105131

106132
LICENSE

0 commit comments

Comments
 (0)