Skip to content

Commit 49fc3f4

Browse files
authored
Merge pull request #2032 from aboutcode-org/restructure-readme
Update README.rst to improve structure per issue - aboutcode-org/www.aboutcode.org#43
2 parents d457487 + 4347e72 commit 49fc3f4

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

README.rst

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1+
===========
12
ScanCode.io
23
===========
34

4-
ScanCode.io is a server to script and automate software composition analysis
5-
with ScanPipe pipelines.
5+
ScanCode.io provides a Web UI and API to run and review complex scans in rich scripted pipelines, on different kinds of containers, docker images, package archives, manifests etc, to get information on licenses, copyrights, sources, and vulnerabilities.
66

7-
First application is for Docker container and VM composition analysis.
7+
Why Use ScanCode.io?
8+
====================
89

9-
Getting started
10-
---------------
10+
ScanCode.io provides an easy-to-use front-end to ScanCode Toolkit and other AboutCode projects.The flexible pipeline technology supports advanced scanning tasks such as container scanning and deploy-to-develop analysis. You can run ScanCode.io in a Docker container or install it on a Linux server. It provides full support for generating and consuming CycloneDX and SPDX SBOMs.
1111

12-
The ScanCode.io documentation is available here: https://scancodeio.readthedocs.org/
12+
Getting Started
13+
===============
1314

14-
If you have questions that are not covered by our
15-
`Documentation <https://scancodeio.readthedocs.io/en/latest/faq.html>`_ or
16-
`FAQs <https://scancodeio.readthedocs.io/en/latest/faq.html>`_,
17-
please ask them in `Discussions <https://github.com/aboutcode-org/scancode.io/discussions>`_.
15+
Instructions to get you up and running on your local machine are at `Getting Started <https://scancodeio.readthedocs.org/>`_
1816

19-
If you want to contribute to ScanCode.io, start with our
20-
`Contributing <https://scancodeio.readthedocs.io/en/latest/contributing.html>`_ page.
17+
The ScanCode.io documentation also provides:
2118

22-
A new GitHub action is now available at
23-
`scancode-action <https://github.com/aboutcode-org/scancode-action>`_
24-
to run ScanCode.io pipelines from your GitHub Workflows.
25-
Visit https://scancodeio.readthedocs.io/en/latest/automation.html to learn more
26-
about automation.
19+
- prerequisites for installing the software.
20+
- instructions guiding you to start scanning code.
21+
- tutorials that provide hands-on guidance to ScanCode features.
22+
- how to customize your own pipelines.
23+
- how to use a GitHub action to run ScanCode.io pipelines from your GitHub Workflows.
24+
- references explaining integration with other AboutCode projects.
25+
- guidelines for contributing to code development.
26+
27+
If you have questions that are not covered by our documentation,
28+
please ask them in `Discussions <https://github.com/aboutcode-org/scancode.io/discussions>`_.
2729

2830
Build and tests status
2931
----------------------

0 commit comments

Comments
 (0)