Skip to content

Commit 9c6ef39

Browse files
authored
Update README.md to restore RST syntax
1 parent 7219484 commit 9c6ef39

1 file changed

Lines changed: 49 additions & 16 deletions

File tree

README.md

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# ScanCode Toolkit
1+
================
2+
ScanCode Toolkit
3+
================
24

35
ScanCode Toolkit is a set of code scanning tools that detect the origin (copyrights), license and vulnerabilities of code, packages and dependencies in a codebase.
46

5-
## Why
7+
Why Use ScanCode Toolkit?
8+
=========================
69

710
ScanCode Toolkit is the leading tool in scanning depth and accuracy, used by hundreds of software teams. You can use ScanCode Toolkit as a command line tool or as a library.
811

9-
## Getting Started
12+
Getting Started
13+
===============
1014

1115
These instructions will get you a copy of the project up and running on your local machine.
1216

@@ -16,25 +20,29 @@ These instructions will guide you to start scanning code.
1620

1721
https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/synopsis.html#synopsis-quickstart
1822

19-
### Prerequisites
23+
Prerequisites
24+
=============
2025

2126
What things you need to install the software and how to install them.
2227

2328
https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#before-installing
2429

25-
### Exploring ScanCode Features
30+
Exploring ScanCode Features
31+
===========================
2632

2733
Discover the ScanCode command line options that meet your requirements.
2834

2935
https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/index.html
3036

31-
## Guided Tours
37+
Guided Tours
38+
============
3239

3340
These tutorials will provide hands-on guidance to ScanCode features.
3441

3542
https://scancode-toolkit.readthedocs.io/en/stable/tutorials/index.html
3643

37-
### Advanced Topics
44+
Advanced Topics
45+
===============
3846

3947
Expand the ScanCode Licenses and Detection Rules with your own data.
4048

@@ -44,21 +52,39 @@ Generate Attribution from a ScanCode scan.
4452

4553
https://scancode-toolkit.readthedocs.io/en/stable/how-to-guides/generate_attribution.html
4654

47-
## Contributing
55+
Contributing
56+
============
4857

4958
Guidelines for contributing to code development.
5059

5160
https://scancode-toolkit.readthedocs.io/en/stable/contribute/index.html#
5261

53-
## Discover also:
62+
Discover also:
63+
==============
5464

5565
- The ScanCode.io server project here: https://scancodeio.readthedocs.io
5666
- The ScanCode Workbench project for visualization of scancode results data:
5767
https://github.com/nexB/scancode-workbench
5868
- Other companion SCA projects for code origin, license and security analysis
5969
here: https://aboutcode.org
6070

61-
## Build and tests status
71+
Archive extraction
72+
==================
73+
74+
By default ScanCode does not extract files from tarballs, zip files, and
75+
other archives as part of the scan. The archives that exist in a codebase
76+
must be extracted before running a scan: `extractcode` is a bundled utility
77+
behaving as a mostly-universal archive extractor. For example, this command will
78+
recursively extract the mytar.tar.bz2 tarball in the mytar.tar.bz2-extract
79+
directory::
80+
81+
./extractcode mytar.tar.bz2
82+
83+
See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/reference/cli-extractcode.html>`_
84+
and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for details.
85+
86+
Build and tests status
87+
======================
6288

6389
We run 30,000+ tests on each commit on multiple CIs to ensure a good platform
6490
compabitility with multiple versions of Windows, Linux and macOS.
@@ -69,7 +95,8 @@ compabitility with multiple versions of Windows, Linux and macOS.
6995
| |azure| | |docs-rtd| | |docs-github-actions| | |release-github-actions| |
7096
+------------+--------------+-------------------------+----------------------------+
7197

72-
## Benefits of ScanCode?
98+
Benefits of ScanCode
99+
====================
73100

74101
- As a **standalone command-line tool**, ScanCode is **easy to install**, run,
75102
and embed in your CI/CD processing pipeline.
@@ -126,7 +153,8 @@ for upcoming features.
126153

127154
See also https://github.com/aboutcode-org/aboutcode?tab=readme-ov-file#aboutcode for related companion projects and tools.
128155

129-
## Support
156+
Support
157+
=======
130158

131159
If you have a problem, a suggestion or found a bug, please enter a ticket at:
132160
https://github.com/aboutcode-org/scancode-toolkit/issues
@@ -142,7 +170,8 @@ For discussions and chats, we have:
142170
* The discussion channel for `scancode <https://matrix.to/#/#aboutcode-org_scancode:gitter.im>`_
143171
specifically aimed at users and developers using scancode-toolkit.
144172

145-
## Source code and downloads
173+
Source code and downloads
174+
=========================
146175

147176
* https://github.com/aboutcode-org/scancode-toolkit/releases
148177
* https://github.com/aboutcode-org/scancode-toolkit.git
@@ -151,7 +180,8 @@ For discussions and chats, we have:
151180
* https://github.com/aboutcode-org/scancode-plugins.git
152181
* https://github.com/aboutcode-org/thirdparty-packages.git
153182

154-
## License
183+
License
184+
=======
155185

156186
* Apache-2.0 is the overall license
157187
* CC-BY-4.0 applies to reference datasets.
@@ -161,7 +191,8 @@ For discussions and chats, we have:
161191
See the NOTICE file and the .ABOUT files that document the origin and license of
162192
the third-party code used in ScanCode for more details.
163193

164-
## Status of Tests
194+
Status of Tests
195+
===============
165196

166197
.. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop
167198
:target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop
@@ -179,7 +210,8 @@ the third-party code used in ScanCode for more details.
179210
:target: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml
180211
:alt: Release tests
181212

182-
## Acknowledgements, Funding, Support and Sponsoring
213+
Acknowledgements, Funding, Support and Sponsoring
214+
=================================================
183215

184216
This project is funded, supported and sponsored by:
185217

@@ -309,3 +341,4 @@ Communications Networks, Content and Technology under grant agreement No 1010695
309341
:height: 40
310342
:alt: NGI Discovery logo
311343

344+
**End of ScanCode Toolkit README**

0 commit comments

Comments
 (0)