Skip to content

Enhance README to Promote ScanCode.io, Improve Documentation Visibility, and Add Key References #4108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 38 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,28 @@ Read more about ScanCode here: https://scancode-toolkit.readthedocs.io/.

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

Discover also:
🔍 Discover Also

🚀 ScanCode.io – The Powerful Companion to ScanCode-toolkit
Looking for a **web-based platform** to automate and manage your code scans?
Check out **ScanCode.io** 👉 [scancode.io](https://scancode.io)!

✅ Automate License & Security Scanning

✅ Web UI for Managing Scan Results

✅ Built on Top of ScanCode-toolkit

🔗 Get Started: [scancode.io](https://scancode.io) | 📖 Docs: [scancodeio.readthedocs.io](https://scancodeio.readthedocs.io)

🖥️ ScanCode Workbench – Visualize & Explore Scan Results
Need a **desktop tool** to analyze your ScanCode results with an interactive interface?
Try **ScanCode Workbench** 👉 [GitHub](https://github.com/nexB/scancode-workbench)!

🛠️ More Open Source SCA Tools
Looking for additional tools for **code origin, license compliance, and security analysis**?
Explore **more open-source projects** from the AboutCode ecosystem 👉 [AboutCode.org](https://aboutcode.org)

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


Build and tests status
Expand Down Expand Up @@ -66,9 +81,9 @@ Why use ScanCode?
- You can save your scan results as **JSON, YAML, HTML, CycloneDX or SPDX** or
even create your own format with Jinja templates.

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

- ScanCode output data can be easily visualized and analysed using the
`ScanCode Workbench <https://github.com/nexB/scancode-workbench>`_ desktop app.
Expand Down Expand Up @@ -104,8 +119,13 @@ for upcoming features.
Documentation
=============

The ScanCode documentation is hosted at
`scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>`_.
The ScanCode documentation is hosted at
`scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>`_.

**If you are looking for a web-based solution** for your scans,

you can use [ScanCode.io](https://scancode.io) for automation and centralized management of scan results.


If you are new to visualization of scancode results data, start with our
`newcomer <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/newcomer.html>`_ page.
Expand Down Expand Up @@ -158,8 +178,13 @@ There are a few common ways to `install ScanCode <https://scancode-toolkit.readt
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#pip-install>`_
[Note that this is not supported on arm64 machines]

- `Run in a Docker container with a git clone and "docker run"
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker>`_
- `Run in a Docker container with a git clone and "docker run"
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker>`_

**If you are looking for a server-side solution,**

you can use [ScanCode.io](https://scancode.io), a web-based platform that facilitates automated software composition analysis and efficient management of scan results.


- In Fedora 40+ you can `dnf install scancode-toolkit`

Expand Down