11AboutCode 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+ ------------
166The AboutCode Toolkit and ABOUT files provide a simple way to document the
177origin, license, usage and other important or interesting information about
188third-party software components that you use in your project.
199
2010You start by storing ABOUT files (a small YAML formatted text file with field/value pairs)
2111side-by-side with each of the third-party software components you use.
2212Each ABOUT file documents origin and license for one software.
23- For more information on the ABOUT file format, visit http://www.dejacode.org
2413There are many examples of ABOUT files (valid or invalid) in the testdata/
2514directory of the whole repository.
2615
@@ -31,12 +20,25 @@ In addition, this tool is able to generate attribution notices and
3120identify redistributable source code used in your project to help you comply
3221with 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:
3524https://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+
3739REQUIREMENTS
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.
4042You will need to install a Python interpreter if you do not have one already
4143installed.
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+
6692REFERENCE
6793---------
6894See 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:
100126HACKING
101127-------
102128We 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
106132LICENSE
0 commit comments