Skip to content

Commit 4444e8b

Browse files
committed
Improve doc for release
Update badges and links to CI Use devdelop branch, not yet main Signed-off-by: Philippe Ombredanne <[email protected]>
1 parent 945b580 commit 4444e8b

File tree

3 files changed

+48
-42
lines changed

3 files changed

+48
-42
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Ouputs:
9191

9292

9393
License detection:
94-
~~~~~~~~~~~~~~~~~
94+
~~~~~~~~~~~~~~~~~~~
9595

9696
- The SPDX license list has been update to 3.13
9797

README.rst

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ A typical software project often reuses hundreds of third-party packages.
66
License and origin information is not always easy to find and not normalized:
77
ScanCode discovers and normalizes this data for you.
88

9-
Read more about ScanCode here: `scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>`_.
9+
Read more about ScanCode here: `scancode-toolkit.readthedocs.io
10+
<https://scancode-toolkit.readthedocs.io/en/latest/>`_.
11+
12+
Check out the code at https://github.com/nexB/scancode-toolkit
13+
1014

1115
Why use ScanCode?
1216
=================
@@ -25,8 +29,10 @@ Why use ScanCode?
2529
`RedHat Fabric8 analytics <https://github.com/fabric8-analytics>`_,
2630
and many more.
2731

28-
- ScanCode detects licenses, copyrights, package manifests, direct
29-
dependencies, and more both in **source code** and **binary** files.
32+
- ScanCode detects licenses, copyrights, package manifests, direct dependencies,
33+
and more both in **source code** and **binary** files and is considered as the
34+
best-in-class and reference tool in this domain, re-used as the core tools for
35+
software composition data collection by several open source tools.
3036

3137
- ScanCode provides the **most accurate license detection engine** and does a
3238
full comparison (also known as diff or red line comparison) between a database
@@ -37,14 +43,12 @@ Why use ScanCode?
3743
new and improved scanners, data summarization, package manifest parsers, and
3844
new outputs.
3945

40-
- You can save your scan results as **JSON, HTML, CSV or SPDX**. And you can use the
41-
companion `ScanCode workbench GUI app <https://github.com/nexB/scancode-workbench>`_
42-
to review and display scan results, statistics and graphics.
46+
- You can save your scan results as **JSON, HTML, CSV or SPDX** or create your
47+
own format with Jinja templates.
4348

4449
- You can also organize and run ScanCode server-side with the
4550
companion `ScanCode.io web app <https://github.com/nexB/scancode.io>`_
46-
to organize and store multiple scan projects including scripting scanning piplines.
47-
51+
to organize and store multiple scan projects including scripted scanning pipelines.
4852

4953
- ScanCode is **actively maintained**, has a **growing users and contributors
5054
community**.
@@ -53,29 +57,35 @@ Why use ScanCode?
5357

5458
- ScanCode has an extensive and growing documentation.
5559

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,
63+
PHP Composer and composer.lock, Conda, CPAN, Debian, Apple dmg,
64+
Java EAR, WAR, JAR, FreeBSD packages, Rubygems gemspec, Gemfile and Gemfile.lock,
65+
Go modules, Haxe packages, InstallShield installers, iOS apps, ISO images,
66+
Apache IVY, JBoss Sar, R CRAN, Apache Maven, Meteor, Mozilla extensions,
67+
MSI installers, JavaScript npm packages, package-lock.json, yarn.lock,
68+
NSIS Installers, NugGet, OPam, Cocoapods, Python PyPI setup.py, setup.cfg, and
69+
several related lockfile formats, semi structured README
70+
files such as README.android, README.chromium, README.facebook, README.google,
71+
README.thirdparty, RPMs, Shell Archives, Squashfs images, Java WAR, Windows executables.
72+
73+
5674
See our `roadmap <https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html>`_
5775
for upcoming features.
5876

5977

6078
Build and tests status
6179
======================
6280

63-
+-------+--------------+-----------------+--------------+
64-
|Branch | **Coverage** | **Linux/macOS** | **Windows** |
65-
+=======+==============+=================+==============+
66-
|Master | |master-cov| | |master-posix| | |master-win| |
67-
+-------+--------------+-----------------+--------------+
68-
|Develop| |devel-cov| | |devel-posix| | |devel-win| |
69-
+-------+--------------+-----------------+--------------+
81+
We run tests on multiple CIs to ensure a good platform compabitility and on
82+
multiple version of Windows, Linux and macOS.
7083

71-
Documentation Build
72-
-------------------
73-
74-
+--------+--------------+
75-
|Version | **RTD Build**|
76-
+========+==============+
77-
| Latest | |docs-rtd| |
78-
+--------+--------------+
84+
+--------------+--------------+--------------+
85+
| **Appveyor** | **Azure** | **RTD Build**|
86+
+==============+==============+==============+
87+
| |appveyor| | |azure| | |docs-rtd| |
88+
+--------------+--------------+--------------+
7989

8090

8191
Documentation
@@ -110,7 +120,9 @@ Installation
110120
============
111121

112122
Before installing ScanCode make sure that you have installed the prerequisites
113-
properly. This means installing Python (Python 3.6+ is required).
123+
properly. This means installing Python (Python 3.6 or higher is required.
124+
When installing the app tarball or zip, only Python 3.6 is supported for now).
125+
114126
See `prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_
115127
for detailed information on the support platforms and Python versions.
116128

@@ -215,19 +227,13 @@ See the NOTICE file and the .ABOUT files that document the origin and license of
215227
the third-party code used in ScanCode for more details.
216228

217229

218-
.. |master-posix| image:: https://api.travis-ci.org/nexB/scancode-toolkit.png?branch=master
230+
.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/4webymu0l2ip8utr?svg=true
219231
:target: https://travis-ci.org/nexB/scancode-toolkit
220-
:alt: Linux Master branch tests status
221-
.. |devel-posix| image:: https://api.travis-ci.org/nexB/scancode-toolkit.png?branch=develop
222-
:target: https://travis-ci.org/nexB/scancode-toolkit
223-
:alt: Linux Develop branch tests status
224-
225-
.. |master-win| image:: https://ci.appveyor.com/api/projects/status/4webymu0l2ip8utr/branch/master?png=true
226-
:target: https://ci.appveyor.com/project/nexB/scancode-toolkit
227-
:alt: Windows Master branch tests status
228-
.. |devel-win| image:: https://ci.appveyor.com/api/projects/status/4webymu0l2ip8utr/branch/develop?png=true
229-
:target: https://ci.appveyor.com/project/nexB/scancode-toolkit
230-
:alt: Windows Develop branch tests status
232+
:alt: Appveyor tests status (Windows)
233+
234+
.. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop
235+
:target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop
236+
:alt: Azure tests status (Linux, macOS, Windows)
231237

232238
.. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=latest
233239
:target: https://scancode-toolkit.readthedocs.io/en/latest/?badge=latest

docs/source/getting-started/install.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -286,13 +286,13 @@ Or you can run the following if you have `Git <https://git-scm.com/>`_ installed
286286
Now, by default the files are checked out to the develop branch, but you can jump to any checkpoint
287287
using the following command::
288288

289-
git checkout main
289+
git checkout develop
290290

291-
Here, ``main`` branch has the latest release of Scancode-Toolkit. You can also check out to any
292-
of the following:
291+
Here, ``develop`` branch has the latest release of Scancode-Toolkit.
292+
You can also check out to any of the following:
293293

294-
- Branches (Locally created or already present) [Example - ``main``]
295-
- Tags (essentially version numbers) [Example - ``v21.2.25``, ``v21.6.1``]
294+
- Branches (Locally created or already present) [Example - ``develop``]
295+
- Tags (essentially version numbers) [Example - ``v21.6.7``, ``v21.5.31``]
296296
- Commits (use the shortened commit hash) [Example - ``4502055``, ``f276398``]
297297

298298

0 commit comments

Comments
 (0)