You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
to review and display scan results, statistics, and graphics.
42
+
to review and display scan results, statistics and graphics.
38
43
39
-
- ScanCode is **actively maintained**, has a **growing community of users**.
44
+
- ScanCode is **actively maintained**, has a **growing users and contributors
45
+
community**.
40
46
41
-
- ScanCode is heavily **tested** with an automated test suite of over **8000 tests**.
47
+
- ScanCode is heavily **tested** with an automated test suite of over **20,000 tests**.
42
48
43
-
- ScanCode has extensive and updated Documentation help for users.
49
+
See our `roadmap <https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html>`_
50
+
for upcoming features.
44
51
45
-
See our `roadmap <https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html>`_ for upcoming features.
46
52
47
53
Build and tests status
48
54
======================
@@ -74,9 +80,16 @@ If you are new to Scancode, start `here <https://scancode-toolkit.readthedocs.io
74
80
75
81
Other Important Documentation Pages:
76
82
77
-
- A `Synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_ of ScanCode Command Line Options
78
-
- Tutorials on `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_ and `How to Visualize Scan results <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_visualize_scan_results.html>`_
79
-
- An exhaustive List of `All Available Options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_
83
+
- A `synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_
84
+
of ScanCode command line options.
85
+
86
+
- Tutorials on:
87
+
88
+
- `How to run a scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
89
+
- `How to visualize scan results <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_visualize_scan_results.html>`_
90
+
91
+
- An exhaustive list of `all available options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_
92
+
80
93
- Documentation on `Contributing to Code Development <https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html>`_
81
94
- Documentation on `Plugin Architecture <https://scancode-toolkit.readthedocs.io/en/latest/plugins/plugin_arch.html>`_
@@ -87,50 +100,71 @@ See also https://aboutcode.org for related companion projects and tools.
87
100
Installation
88
101
============
89
102
90
-
Before installing ScanCode make sure you've installed the prerequisites properly. This mainly
91
-
refers to installing the required Python interpreter (Python 3.6 is recommended). Refer
92
-
`Prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_ for detailed information on all different platforms and Python Versions.
103
+
Before installing ScanCode make sure that you have installed the prerequisites
104
+
properly. This means installing Python (Python 3.6 is required in most cases).
105
+
See `prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_
106
+
for detailed information on the support platforms and Python versions.
107
+
108
+
There are a few common ways to `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
109
+
110
+
- `*Recommended* installation as an application: Download a release archive, extract and run.
There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
95
122
96
-
- `Installation as an Application: Downloading Releases <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-as-an-application-downloading-releases>`_ *(Recommended)*
97
-
- `Installation via Docker: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker>`_
98
-
- `Installation from Source Code: Git Clone <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-from-source-code-git-clone>`_
99
-
- `Installation as a library: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#pip-install>`_
100
123
101
124
Quick Start
102
125
===========
103
126
104
-
Note the `Commands Variation <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#commands-variation>`_ across Installation methods and Platforms.
127
+
Note the `commands variation <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#commands-variation>`_
128
+
across installation methods and platforms.
105
129
106
130
You can run an example scan printed on screen as JSON::
107
131
108
132
./scancode -clip --json-pp - samples
109
133
110
-
Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_ Tutorial
111
-
to perform a basic scan on the ``samples`` directory distributed by default with Scancode.
134
+
Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
135
+
tutorial to perform a basic scan on the ``samples`` directory distributed by
136
+
default with Scancode.
112
137
113
138
See more command examples::
114
139
115
140
./scancode --examples
116
141
117
-
Refer `How to set what will be detected in Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html>`_
118
-
and `How to specify Scancode Output Format <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_format_scan_output.html>`_ for more information.
142
+
See `How to select what will be detected in a scan
You can also refer to `Command Line Options Synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_ and an exhaustive List of `All Available Options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_.
121
152
122
153
Archive extraction
123
154
==================
124
155
125
-
The archives that exist in a codebase must be extracted before running a scan:
126
-
ScanCode does not extract files from tarballs, zip files, etc. as part of the
127
-
scan. The bundled utility `extractcode` is a mostly-universal archive extractor.
128
-
For example, this command will recursively extract the mytar.tar.bz2 tarball in
129
-
the mytar.tar.bz2-extract directory::
156
+
ScanCode does not extract by default files from tarballs, zip files, and
157
+
other archives as part of the scan. The archives that exist in a codebase
158
+
must be extracted before running a scan: the bundled utility `extractcode`
159
+
is a mostly-universal archive extractor. For example, this command will
160
+
recursively extract the mytar.tar.bz2 tarball in the mytar.tar.bz2-extract
161
+
directory::
130
162
131
163
./extractcode mytar.tar.bz2
132
164
133
-
Refer `All Extractcode Options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html#all-extractcode-options>`_ and `How To Extract Archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for more information.
165
+
See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html#all-extractcode-options>`_
166
+
and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for details.
0 commit comments