From a3829a3a88a1d57744ea83dd2a06ccc7e4616904 Mon Sep 17 00:00:00 2001 From: Avan2021 Date: Mon, 20 Jan 2025 16:54:29 +0530 Subject: [PATCH 1/7] Updated README with ScanCode.io references Signed-off-by: Avan2021 --- README.rst | 37 +++++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index b660c05473..10be6257ce 100644 --- a/README.rst +++ b/README.rst @@ -10,13 +10,26 @@ 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 @@ -69,6 +82,14 @@ Why use ScanCode? - You can also organize and run ScanCode server-side with the companion `ScanCode.io web app `_ to organize and store multiple scan projects including scripted scanning pipelines. + πŸš€Want to **automate your scans** and manage results more easily? + πŸš€Try **ScanCode.io** – a powerful web-based platform built on top of ScanCode-toolkit! + With **ScanCode.io**, you can: + βœ… Automate License & Security Scanning + βœ… Organize & Store Scan Results + βœ… Run Customizable Pipelines for Code Audits + πŸ”— Learn More: [scancode.io](https://scancode.io) | πŸ“– [Docs](https://scancodeio.readthedocs.io) + - ScanCode output data can be easily visualized and analysed using the `ScanCode Workbench `_ desktop app. @@ -106,6 +127,8 @@ Documentation The ScanCode documentation is hosted at `scancode-toolkit.readthedocs.io `_. +**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 `_ page. @@ -160,6 +183,8 @@ There are a few common ways to `install ScanCode `_ + **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` From 73be9c6bfef535cc60fe842a60a35c541024c6ce Mon Sep 17 00:00:00 2001 From: Avan2021 Date: Mon, 20 Jan 2025 17:02:32 +0530 Subject: [PATCH 2/7] Updated README with ScanCode.io references Signed-off-by: Avan2021 --- README.rst | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 10be6257ce..6d8bb9b2a3 100644 --- a/README.rst +++ b/README.rst @@ -10,9 +10,9 @@ 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 +πŸš€ 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)! @@ -22,11 +22,11 @@ Check out **ScanCode.io** πŸ‘‰ [scancode.io](https://scancode.io)! πŸ”— Get Started: [scancode.io](https://scancode.io) | πŸ“– Docs: [scancodeio.readthedocs.io](https://scancodeio.readthedocs.io) -### πŸ–₯️ ScanCode Workbench – Visualize & Explore Scan Results +πŸ–₯️ 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 +πŸ› οΈ 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) @@ -81,15 +81,14 @@ Why use ScanCode? - You can also organize and run ScanCode server-side with the companion `ScanCode.io web app `_ - to organize and store multiple scan projects including scripted scanning pipelines. + to organize and store multiple scan projects including scripted scanning pipelines. πŸš€Want to **automate your scans** and manage results more easily? πŸš€Try **ScanCode.io** – a powerful web-based platform built on top of ScanCode-toolkit! With **ScanCode.io**, you can: βœ… Automate License & Security Scanning βœ… Organize & Store Scan Results βœ… Run Customizable Pipelines for Code Audits - πŸ”— Learn More: [scancode.io](https://scancode.io) | πŸ“– [Docs](https://scancodeio.readthedocs.io) - + πŸ”— Learn More: [scancode.io](https://scancode.io) | πŸ“– [Docs](https://scancodeio.readthedocs.io) - ScanCode output data can be easily visualized and analysed using the `ScanCode Workbench `_ desktop app. @@ -126,9 +125,9 @@ Documentation ============= The ScanCode documentation is hosted at -`scancode-toolkit.readthedocs.io `_. +`scancode-toolkit.readthedocs.io `_. **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. +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 `_ page. @@ -182,9 +181,9 @@ There are a few common ways to `install ScanCode `_ + `_ **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. + 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` From 09c11e68d775ce24cb651db8f9d352b8750f17f4 Mon Sep 17 00:00:00 2001 From: Avan2021 Date: Mon, 20 Jan 2025 17:07:42 +0530 Subject: [PATCH 3/7] Updated README with ScanCode.io references Signed-off-by: Avan2021 --- README.rst | 42 +++++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 6d8bb9b2a3..4eb2d2120e 100644 --- a/README.rst +++ b/README.rst @@ -79,16 +79,22 @@ 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 `_ - to organize and store multiple scan projects including scripted scanning pipelines. - πŸš€Want to **automate your scans** and manage results more easily? - πŸš€Try **ScanCode.io** – a powerful web-based platform built on top of ScanCode-toolkit! - With **ScanCode.io**, you can: - βœ… Automate License & Security Scanning - βœ… Organize & Store Scan Results - βœ… Run Customizable Pipelines for Code Audits - πŸ”— Learn More: [scancode.io](https://scancode.io) | πŸ“– [Docs](https://scancodeio.readthedocs.io) +You can also organize and run ScanCode server-side with the +companion `ScanCode.io web app `_ +to organize and store multiple scan projects including scripted scanning pipelines. + +πŸš€ Want to **automate your scans** and manage results more easily? + +πŸš€ Try **ScanCode.io** – a powerful web-based platform built on top of ScanCode-toolkit! + +With **ScanCode.io**, you can: + +βœ… Automate License & Security Scanning +βœ… Organize & Store Scan Results +βœ… Run Customizable Pipelines for Code Audits + +πŸ”— Learn More: [scancode.io](https://scancode.io) | πŸ“– [Docs](https://scancodeio.readthedocs.io) + - ScanCode output data can be easily visualized and analysed using the `ScanCode Workbench `_ desktop app. @@ -124,10 +130,13 @@ for upcoming features. Documentation ============= -The ScanCode documentation is hosted at +The ScanCode documentation is hosted at `scancode-toolkit.readthedocs.io `_. + **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. + +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 `_ page. @@ -180,10 +189,13 @@ There are a few common ways to `install ScanCode `_ [Note that this is not supported on arm64 machines] -- `Run in a Docker container with a git clone and "docker run" +- `Run in a Docker container with a git clone and "docker run" `_ - **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. + +**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` From fe61535d77237abfbb42bda737e4b482e80b7394 Mon Sep 17 00:00:00 2001 From: Avan2021 Date: Mon, 20 Jan 2025 17:12:50 +0530 Subject: [PATCH 4/7] changes in readme Signed-off-by: Avan2021 --- README.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 4eb2d2120e..4956d24046 100644 --- a/README.rst +++ b/README.rst @@ -79,21 +79,21 @@ 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 `_ -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 `_ + to organize and store multiple scan projects including scripted scanning pipelines. -πŸš€ Want to **automate your scans** and manage results more easily? + πŸš€ Want to **automate your scans** and manage results more easily? + πŸš€ Try **ScanCode.io** – a powerful web-based platform built on top of ScanCode-toolkit! + With **ScanCode.io**, you can: -πŸš€ Try **ScanCode.io** – a powerful web-based platform built on top of ScanCode-toolkit! + βœ… Automate License & Security Scanning -With **ScanCode.io**, you can: + βœ… Organize & Store Scan Results -βœ… Automate License & Security Scanning -βœ… Organize & Store Scan Results -βœ… Run Customizable Pipelines for Code Audits + βœ… Run Customizable Pipelines for Code Audits -πŸ”— Learn More: [scancode.io](https://scancode.io) | πŸ“– [Docs](https://scancodeio.readthedocs.io) + πŸ”— Learn More: [scancode.io](https://scancode.io) | πŸ“– [Docs](https://scancodeio.readthedocs.io) - ScanCode output data can be easily visualized and analysed using the From 78503f0f6b570ba2a71c57c75e458d2c197217c4 Mon Sep 17 00:00:00 2001 From: Avan2021 Date: Mon, 20 Jan 2025 17:18:11 +0530 Subject: [PATCH 5/7] changes in the spacing Signed-off-by: Avan2021 --- README.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 4956d24046..527c52f28f 100644 --- a/README.rst +++ b/README.rst @@ -16,9 +16,9 @@ Check out the code at https://github.com/nexB/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 +βœ… 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) @@ -84,7 +84,9 @@ Why use ScanCode? to organize and store multiple scan projects including scripted scanning pipelines. πŸš€ Want to **automate your scans** and manage results more easily? + πŸš€ Try **ScanCode.io** – a powerful web-based platform built on top of ScanCode-toolkit! + With **ScanCode.io**, you can: βœ… Automate License & Security Scanning @@ -192,9 +194,8 @@ There are a few common ways to `install ScanCode `_ -**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. + **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` From 0bd9a919a5c06caa3887ab7406cb63b8fd035a7d Mon Sep 17 00:00:00 2001 From: Avan2021 Date: Mon, 20 Jan 2025 17:20:31 +0530 Subject: [PATCH 6/7] changes in the spacing Signed-off-by: Avan2021 --- README.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 527c52f28f..2c59b97446 100644 --- a/README.rst +++ b/README.rst @@ -16,9 +16,11 @@ Check out the code at https://github.com/nexB/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
+βœ… 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) @@ -194,7 +196,8 @@ There are a few common ways to `install ScanCode `_ - **If you are looking for a server-side solution,**
+ **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. From 05420ad422373160ae38a94b2c027ecfef28947e Mon Sep 17 00:00:00 2001 From: Avan2021 Date: Mon, 20 Jan 2025 17:57:26 +0530 Subject: [PATCH 7/7] changes for sign-off Signed-off-by: Avan2021 --- README.rst | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 2c59b97446..4c7ccd80e7 100644 --- a/README.rst +++ b/README.rst @@ -85,21 +85,6 @@ Why use ScanCode? companion `ScanCode.io web app `_ to organize and store multiple scan projects including scripted scanning pipelines. - πŸš€ Want to **automate your scans** and manage results more easily? - - πŸš€ Try **ScanCode.io** – a powerful web-based platform built on top of ScanCode-toolkit! - - With **ScanCode.io**, you can: - - βœ… Automate License & Security Scanning - - βœ… Organize & Store Scan Results - - βœ… Run Customizable Pipelines for Code Audits - - πŸ”— Learn More: [scancode.io](https://scancode.io) | πŸ“– [Docs](https://scancodeio.readthedocs.io) - - - ScanCode output data can be easily visualized and analysed using the `ScanCode Workbench `_ desktop app. @@ -197,7 +182,7 @@ There are a few common ways to `install ScanCode `_ **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.