|
1 | 1 | # Getting started |
2 | 2 |
|
3 | | -The AboutCode community designs, develops, and sustains an open source |
| 3 | +The AboutCode community designs, develops, and sustains an open source |
4 | 4 | ecosystem of interoperable tools, accurate data, and practical standards to |
5 | 5 | enable organizations of any size to identify open source or other third-party |
6 | | -software, automate license compliance, and improve software supply chain |
7 | | -security. AboutCode software and data can provide a comprehensive solution for some organizations, or an organization can reuse AboutCode "building blocks" |
| 6 | +software, automate license compliance, and improve software supply chain |
| 7 | +security. AboutCode software and data can provide a comprehensive solution for |
| 8 | +some organizations, or an organization can reuse AboutCode "building blocks" |
8 | 9 | in their own systems and workflows. |
9 | 10 |
|
10 | | -The purpose of this Getting Started section is to help you understand what software or data AboutCode projects provide so that you can determine how to |
| 11 | +The purpose of this Getting Started section is to help you understand what |
| 12 | +software or data AboutCode projects provide so that you can determine how to |
11 | 13 | best use them to meet your requirements for software identification, license |
12 | | -compliance and supply chain security. Our approach is to describe common use cases and show you how specific AboutCode capabilities apply to those use |
| 14 | +compliance and supply chain security. Our approach is to describe common use |
| 15 | +cases and show you how specific AboutCode capabilities apply to those use |
13 | 16 | cases. |
14 | 17 |
|
15 | 18 | The use cases are grouped according to 3 major topics: |
16 | 19 | - Software identification |
17 | 20 | - License compliance |
18 | 21 | - Supply chain security |
19 | 22 |
|
20 | | -If you already know which AboutCode projects you are interested in you can |
21 | | -find project information in the **AboutCode Projects Overview** section of the |
| 23 | +If you already know which AboutCode projects you are interested in you can |
| 24 | +find project information in the **AboutCode Projects Overview** section of the |
22 | 25 | home page of this website. Each project card provides comprehensive project |
23 | 26 | information including: |
24 | 27 | - Description |
25 | 28 | - Documentation URL |
26 | 29 | - GitHub Repository URL |
27 | 30 | - Licenses for software, data and services as applicable |
28 | 31 | - Primary language |
29 | | -- Platform |
| 32 | +- Platform |
30 | 33 |
|
31 | 34 | The projects are presented in 5 categories: |
32 | | -- Applications: These projects offer an application that you can install in the cloud or a local environment. |
33 | | -- ScanCode: These projects are components or extensions of ScanCode. |
34 | | -- Package-URL: These projects provide tools and data to support the use of the PURL (Package-URL) or VERS (Version Range Specifier) specifications. |
35 | | -- Inspectors: AboutCode Inspectors are special-purpose analysis tools. You can run them as a ScanCode Toolkit plugin, as steps in a ScanCode.io pipeline, or from the command line. |
36 | | -- Libraries: AboutCode libraries are key building blocks for the AboutCode software and data stack - they have also been incorporated into other major |
37 | | -FOSS projects and are available for use by anyone. |
38 | | - |
39 | | -If you questions about how to apply AboutCode building blocks to your requirements please join one of our community meetings or on Gitter or Slack. |
40 | | -See our [Meetings page](https://aboutcode-org.github.io/www.aboutcode.org/docs/about/about-meetings) for details. |
41 | | - |
42 | | - |
43 | | - |
44 | | - |
| 35 | +- [Applications](/#application-projects): These projects offer an application |
| 36 | + that you can install in the cloud or a local environment. |
| 37 | +- [ScanCode](/#scancode-projects): These projects are components or extensions |
| 38 | + of ScanCode. |
| 39 | +- [Package-URL](/#purl-projects): These projects provide tools and data to |
| 40 | + support the use of the PURL (Package-URL) or VERS (Version Range Specifier) |
| 41 | + specifications. |
| 42 | +- [Inspectors](/#inspectors): AboutCode Inspectors are special-purpose |
| 43 | + analysis tools. You can run them as a ScanCode Toolkit plugin, as steps in |
| 44 | + a ScanCode.io pipeline, or from the command line. |
| 45 | +- [Libraries](/#libraries): AboutCode libraries are key building blocks for |
| 46 | + the AboutCode software and data stack - they have also been incorporated |
| 47 | + into other major FOSS projects and are available for use by anyone. |
| 48 | + |
| 49 | +If you have questions about how to apply AboutCode building blocks to your |
| 50 | +requirements, please join one of our community meetings or on Gitter or Slack. |
| 51 | +See our [Meetings page](/docs/about/about-meetings) for details. |
0 commit comments