@@ -23,6 +23,7 @@ with open source licenses conditions.
2323This version of the AboutCode Toolkit follows the ABOUT specification version 3.2.3 at:
2424https://aboutcode-toolkit.readthedocs.io/en/latest/specification.html
2525
26+
2627Build and tests status
2728----------------------
2829
@@ -46,13 +47,17 @@ version may be pre-installed, open a terminal and type:
4647
4748 python --version
4849
50+ .. note ::
51+ Debian has decided that distutils is not a core python package, so it is not included in the last versions of debian and debian-based OSes.
52+
53+ A solution is to run: `sudo apt install python3-distutils `
54+
4955On Windows or Mac, you can download the latest Python here:
5056 https://www.python.org/downloads/
5157
5258Download the .msi installer for Windows or the .dmg archive for Mac.
5359Open and run the installer using all the default options.
5460
55-
5661INSTALLATION
5762------------
5863Checkout or download and extract the AboutCode Toolkit from:
@@ -63,16 +68,20 @@ To install all the needed dependencies in a virtualenv, run (on posix):
6368or on windows:
6469 configure
6570
71+ .. note ::
72+ For MacOS users, it's a known issue the Python36 may case SSL Certificates error if the Certificates is not up to date.
6673
67- Activate the virtualenv
74+ A solution is to run: `sudo /Applications/Python\\ 3.6/Install\\ Certificates.command ` to upgrade the outdated certificates.
75+
76+ ACTIVATE the VIRTUALENV
6877-----------------------
6978To activate the virtualenv, run (on posix):
7079 source venv/bin/activate
7180or on windows:
7281 venv\\ bin\\ activate
7382
7483
75- Deactivate the virtualenv
84+ DEACTIVATE the VIRTUALENV
7685-------------------------
7786To deactivate the virtualenv, run (on both posix and windows):
7887 deactivate
@@ -88,24 +97,31 @@ i.e. MAJOR.MINOR.PATCH format
8897 3. PATCH version when making backwards compatible bug fixes.
8998
9099
91- DOCUMENTATION and REFERENCE
92- ---------------------------
93- See https://aboutcode-toolkit.readthedocs.io/en/latest/ for documentation and
94- https://aboutcode-toolkit.readthedocs.io/en/latest/reference.html for reference
95- on aboutcode-toolkit usage.
100+ REFERENCE
101+ ---------
102+ See https://aboutcode-toolkit.readthedocs.io/en/latest/ for documentation.
96103
104+ See https://aboutcode-toolkit.readthedocs.io/en/latest/reference.html for reference.
97105
98106TESTS and DEVELOPMENT
99107---------------------
100108To install all the needed development dependencies, run (on posix):
101- source configure --dev
109+ ./ configure --dev
102110or on windows:
103111 configure --dev
104112
105113To verify that everything works fine you can run the test suite with:
106114 pytest
107115
108116
117+ CLEAN BUILD AND INSTALLED FILES
118+ -------------------------------
119+ To clean the built and installed files, run (on posix):
120+ ./configure --clean
121+ or on windows:
122+ configure --clean
123+
124+
109125HELP and SUPPORT
110126----------------
111127If you have a question or find a bug, enter a ticket at:
@@ -126,7 +142,7 @@ The AboutCode Toolkit is available through GitHub. For the latest version visit:
126142HACKING
127143-------
128144We accept pull requests provided under the same license as this tool.
129- You agree to the http://developercertificate.org/
145+ You agree to the http://developercertificate.org/
130146
131147
132148LICENSE
0 commit comments