Skip to content

Commit eadb506

Browse files
committed
Correct README syntax
Also update the installation instructions. Signed-off-by: Philippe Ombredanne <[email protected]>
1 parent af572e3 commit eadb506

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

README.rst

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,27 @@ ScanCode toolkit
33
================
44

55
A typical software project often reuses hundreds of third-party packages.
6-
License and origin information is not always easy to find and not normalized:
7-
ScanCode discovers and normalizes this data for you.
6+
License and packages, dependencies and origin information is not always easy to
7+
find and not normalized: ScanCode discovers and normalizes this data for you.
88

9-
Read more about ScanCode here: `scancode-toolkit.readthedocs.io
10-
<https://scancode-toolkit.readthedocs.io/>`_.
9+
Read more about ScanCode here: https://scancode-toolkit.readthedocs.io/.
1110

1211
Check out the code at https://github.com/nexB/scancode-toolkit
1312

1413

14+
Build and tests status
15+
======================
16+
17+
We run 30,000+ tests on each commit on multiple CIs to ensure a good platform
18+
compabitility with multiple versions of Windows, Linux and macOS.
19+
20+
+--------------+--------------+--------------+
21+
| **Appveyor** | **Azure** | **RTD Build**|
22+
+==============+==============+==============+
23+
| |appveyor| | |azure| | |docs-rtd| |
24+
+--------------+--------------+--------------+
25+
26+
1527
Why use ScanCode?
1628
=================
1729

@@ -57,9 +69,9 @@ Why use ScanCode?
5769

5870
- ScanCode has an extensive and growing documentation.
5971

60-
- ScanCode can process these packages, build manifest and lockfile formats to extract metadata:
61-
Alpine packages, BUCK files, ABOUT files, Android apps, Autotools, Bazel,
62-
JavaScript Bower, Java Axis, MS Cab, Rust Cargo, Chef Chrome apps,
72+
- ScanCode can process these packages, build manifest and lockfile formats to collect Package URLs and
73+
extract metadata: Alpine packages, BUCK files, ABOUT files, Android apps, Autotools, Bazel,
74+
JavaScript Bower, Java Axis, MS Cab, Rust Cargo, Cocoapods, Chef Chrome apps,
6375
PHP Composer and composer.lock, Conda, CPAN, Debian, Apple dmg,
6476
Java EAR, WAR, JAR, FreeBSD packages, Rubygems gemspec, Gemfile and Gemfile.lock,
6577
Go modules, Haxe packages, InstallShield installers, iOS apps, ISO images,
@@ -68,26 +80,15 @@ Why use ScanCode?
6880
NSIS Installers, NugGet, OPam, Cocoapods, Python PyPI setup.py, setup.cfg, and
6981
several related lockfile formats, semi structured README
7082
files such as README.android, README.chromium, README.facebook, README.google,
71-
README.thirdparty, RPMs, Shell Archives, Squashfs images, Java WAR, Windows executables.
83+
README.thirdparty, RPMs, Shell Archives, Squashfs images, Java WAR, Windows
84+
executables and the Windows registry
85+
and a few more.
7286

7387

7488
See our `roadmap <https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html>`_
7589
for upcoming features.
7690

7791

78-
Build and tests status
79-
======================
80-
81-
We run tests on multiple CIs to ensure a good platform compabitility and on
82-
multiple version of Windows, Linux and macOS.
83-
84-
+--------------+--------------+--------------+
85-
| **Appveyor** | **Azure** | **RTD Build**|
86-
+==============+==============+==============+
87-
| |appveyor| | |azure| | |docs-rtd| |
88-
+--------------+--------------+--------------+
89-
90-
9192
Documentation
9293
=============
9394

@@ -120,14 +121,14 @@ Installation
120121
============
121122

122123
Before installing ScanCode make sure that you have installed the prerequisites
123-
properly. This means installing Python (Python 3.6 or higher is required).
124+
properly. This means installing Python 3.9 for x86/64 architectures. (Python 3.6+ is supported).
124125

125126
See `prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_
126127
for detailed information on the support platforms and Python versions.
127128

128129
There are a few common ways to `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
129130

130-
- `*Recommended* installation as an application: Download a release archive, extract and run.
131+
- **Installation as an application: Install Python 3.9, download a release archive, extract and run**. `This is the recommended installation method.
131132
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-as-an-application-downloading-releases>`_
132133

133134
- `Development installation from source code using a git clone
@@ -219,7 +220,7 @@ License
219220
* Apache-2.0 as the overall license
220221
* CC-BY-4.0 for reference datasets (initially was in the Public Domain).
221222
* Multiple other secondary permissive or copyleft licenses (LGPL, MIT,
222-
BSD, GPL 2/3, etc.) for third-party components.
223+
BSD, GPL 2/3, etc.) for third-party components and test suite code and data.
223224

224225

225226
See the NOTICE file and the .ABOUT files that document the origin and license of

0 commit comments

Comments
 (0)