Skip to content

Commit 3818168

Browse files
committed
Update installation instruction and sync with the README
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 3abfa07 commit 3818168

File tree

2 files changed

+34
-17
lines changed

2 files changed

+34
-17
lines changed

README.rst

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ with open source licenses conditions.
2323
This version of the AboutCode Toolkit follows the ABOUT specification version 3.2.3 at:
2424
https://aboutcode-toolkit.readthedocs.io/en/latest/specification.html
2525

26+
2627
Build 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+
4955
On Windows or Mac, you can download the latest Python here:
5056
https://www.python.org/downloads/
5157

5258
Download the .msi installer for Windows or the .dmg archive for Mac.
5359
Open and run the installer using all the default options.
5460

55-
5661
INSTALLATION
5762
------------
5863
Checkout or download and extract the AboutCode Toolkit from:
@@ -63,16 +68,20 @@ To install all the needed dependencies in a virtualenv, run (on posix):
6368
or 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
-----------------------
6978
To activate the virtualenv, run (on posix):
7079
source venv/bin/activate
7180
or on windows:
7281
venv\\bin\\activate
7382

7483

75-
Deactivate the virtualenv
84+
DEACTIVATE the VIRTUALENV
7685
-------------------------
7786
To 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

98106
TESTS and DEVELOPMENT
99107
---------------------
100108
To install all the needed development dependencies, run (on posix):
101-
source configure --dev
109+
./configure --dev
102110
or on windows:
103111
configure --dev
104112

105113
To 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+
109125
HELP and SUPPORT
110126
----------------
111127
If 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:
126142
HACKING
127143
-------
128144
We 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

132148
LICENSE

docs/source/home.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
.. _home:
2-
3-
=================
41
AboutCode Toolkit
52
=================
63

@@ -50,13 +47,17 @@ version may be pre-installed, open a terminal and type:
5047

5148
python --version
5249

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+
5355
On Windows or Mac, you can download the latest Python here:
5456
https://www.python.org/downloads/
5557

5658
Download the .msi installer for Windows or the .dmg archive for Mac.
5759
Open and run the installer using all the default options.
5860

59-
6061
INSTALLATION
6162
------------
6263
Checkout or download and extract the AboutCode Toolkit from:
@@ -98,9 +99,9 @@ i.e. MAJOR.MINOR.PATCH format
9899

99100
REFERENCE
100101
---------
101-
See https://github.com/nexB/aboutcode-toolkit/blob/master/REFERENCE.rst for reference
102-
on aboutcode-toolkit usage.
102+
See https://aboutcode-toolkit.readthedocs.io/en/latest/ for documentation.
103103

104+
See https://aboutcode-toolkit.readthedocs.io/en/latest/reference.html for reference.
104105

105106
TESTS and DEVELOPMENT
106107
---------------------
@@ -141,7 +142,7 @@ The AboutCode Toolkit is available through GitHub. For the latest version visit:
141142
HACKING
142143
-------
143144
We accept pull requests provided under the same license as this tool.
144-
You agree to the http://developercertificate.org/
145+
You agree to the http://developercertificate.org/
145146

146147

147148
LICENSE

0 commit comments

Comments
 (0)