Skip to content

Commit a8bdae9

Browse files
kushal-p16kushal-p16
committed
docs: replace Projects section with link to aboutcode.org
Signed-off-by: KUSHAL P <kushalmys55@gmail.com>
1 parent 635026c commit a8bdae9

File tree

1 file changed

+70
-77
lines changed

1 file changed

+70
-77
lines changed

‎README.md‎

Lines changed: 70 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -2,118 +2,111 @@
22

33
## What is AboutCode?
44

5-
AboutCode is a family of FOSS projects to uncover metadata about software:
5+
AboutCode is a family of FOSS projects designed to uncover metadata about software, such as:
66

7-
- where does the code come from? which software package?
8-
- what is its license? copyright?
9-
- is the code vulnerable, maintained, well coded?
10-
- what are its dependencies, are there vulnerabilities/licensing issues?
7+
- Where does the code come from?
8+
- Which software package does it belong to?
9+
- What is its license and copyright?
10+
- Is the code vulnerable, maintained, and well-coded?
11+
- What are its dependencies, and are there vulnerabilities or licensing issues?
1112

12-
All these are questions that are important to answer: there are millions of free and open source software components available on the web for reuse.
13+
With millions of open source components available, answering these questions is critical.
1314

14-
Knowing where a software package comes from, what its license is and whether it is vulnerable should be a problem of the past such that everyone can safely consume more free and open source software. We support not only open source software, but also open data, generated and curated by our applications.
15+
AboutCode helps ensure that:
16+
> Software origin, licensing, and security risks are transparent and manageable — enabling safe and confident reuse of open source software.
1517
16-
> [!NOTE]
17-
> This is a repository with information on aboutcode open source activities and not the actual code repository. See the [projects section](#projects) below for links to all the code repositories of our projects with a brief overview and our [wiki](https://github.com/aboutcode-org/aboutcode/wiki) if you are looking to participate.
18+
We support not only open source software, but also open data generated and curated by our tools.
1819

19-
## Important Links
20+
---
2021

21-
- **Homepage**: http://aboutcode.org
22-
- **Documentation**: https://aboutcode.readthedocs.io/en/latest/
23-
- **Chat**: [Gitter](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im) | [Slack](https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og)
24-
- **Weekly Meetings**: [Meeting Minutes](https://github.com/aboutcode-org/aboutcode/wiki/MeetingMinutes)
25-
- **GSoC**: [Wiki](https://github.com/aboutcode-org/aboutcode/wiki)
26-
- **Documentation Build**: ![Doc Build](https://github.com/aboutcode-org/aboutcode/actions/workflows/docs-ci.yml/badge.svg)
22+
## 📌 Note
2723

28-
> [!TIP]
29-
> To manually build the documentation, run `make docs` from the root of this repo.
24+
This repository contains **information about AboutCode open source activities**, not the actual code.
3025

31-
## Contributing
26+
👉 For source code and tools, please refer to the official website:
27+
**https://www.aboutcode.org**
3228

33-
We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation, we'd love your help.
29+
---
3430

35-
**Get started:**
36-
- Read our [CONTRIBUTING.md](CONTRIBUTING.md) guide
37-
- Look for [good first issues](https://github.com/search?q=org%3Aaboutcode-org+label%3A%22good+first+issue%22+state%3Aopen&type=Issues)
38-
- Join our [community chat](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im)
31+
## 🔗 Important Links
3932

40-
## Projects
33+
- 🌐 Homepage: https://www.aboutcode.org
34+
- 📖 Documentation: https://aboutcode.readthedocs.io/en/latest/
35+
- 💬 Chat: Gitter | Slack
36+
- 📝 Weekly Meetings: Meeting Minutes
37+
- 🚀 GSoC: Wiki
38+
- 🛠️ Documentation Build: Doc Build
4139

42-
### Core Tools
40+
---
4341

44-
| Project | Description | Maintainer |
45-
|---------|-------------|------------|
46-
| [ScanCode Toolkit](https://github.com/aboutcode-org/scancode-toolkit) | Detect origin, license, and vulnerabilities in code, packages, and dependencies | [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra) |
47-
| [ScanCode.io](https://github.com/aboutcode-org/scancode.io) | Web UI and API for running complex scans in pipelines with CycloneDX and SPDX support | [@tdruez](https://github.com/tdruez) |
48-
| [ScanCode LicenseDB](https://github.com/aboutcode-org/scancode-licensedb) | Free database of 2400+ software licenses with metadata and detection rules ([public instance](https://scancode-licensedb.aboutcode.org/)) | [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra), [@DennisClark](https://github.com/DennisClark) |
49-
| [ScanCode Workbench](https://github.com/aboutcode-org/scancode-workbench) | Desktop application to visualize and review ScanCode Toolkit scan results | [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra), [@mjherzog](https://github.com/mjherzog) |
50-
| [DejaCode](https://github.com/aboutcode-org/dejacode) | Enterprise application for open source license compliance and supply chain integrity | [@tdruez](https://github.com/tdruez), [@DennisClark](https://github.com/DennisClark) |
51-
| [VulnerableCode](https://github.com/aboutcode-org/vulnerablecode) | Database of software package vulnerabilities with Web UI and API ([public instance](https://public.vulnerablecode.io/)) | [@TG1999](https://github.com/TG1999), [@keshav-space](https://github.com/keshav-space) |
52-
| [PURLDB](https://github.com/aboutcode-org/purldb) | Database of package metadata keyed by PURL with API access | [@JonoYang](https://github.com/JonoYang) |
42+
## 🧩 Projects
5343

54-
### Inspectors
44+
The list of AboutCode projects is now maintained on the official website:
5545

56-
Special-purpose analysis tools that run as ScanCode Toolkit plugins, ScanCode.io pipeline steps, or from the command line.
46+
👉 https://www.aboutcode.org
5747

58-
| Project | Description | Maintainer |
59-
|---------|-------------|------------|
60-
| [binary-inspector](https://github.com/aboutcode-org/binary-inspector) | Extract symbols from ELF, Mach-O, WinPE and other binary formats | [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra) |
61-
| [container-inspector](https://github.com/aboutcode-org/container-inspector) | Analyze structure and provenance of Docker image layers | [@JonoYang](https://github.com/JonoYang), [@chinyeungli](https://github.com/chinyeungli) |
62-
| [source-inspector](https://github.com/aboutcode-org/source-inspector) | Inspect source code to collect symbols, strings, and comments | [@JonoYang](https://github.com/JonoYang) |
63-
| [nuget-inspector](https://github.com/aboutcode-org/nuget-inspector) | Resolve dependencies for .NET/NuGet projects without requiring dotnet SDK | [@JonoYang](https://github.com/JonoYang) |
64-
| [python-inspector](https://github.com/aboutcode-org/python-inspector) | Analyze PyPI packages and resolve Python dependencies | [@TG1999](https://github.com/TG1999), [@chinyeungli](https://github.com/chinyeungli) |
65-
| [debian-inspector](https://github.com/aboutcode-org/debian-inspector) | Parse and inspect Debian control files and codebases | [@JonoYang](https://github.com/JonoYang), [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra) |
66-
| [elf-inspector](https://github.com/aboutcode-org/elf-inspector) | Inspect binary ELF files and collect metadata | [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra) |
67-
| [go-inspector](https://github.com/aboutcode-org/go-inspector) | Extract dependencies and symbols from Go binaries | [@JonoYang](https://github.com/JonoYang) |
68-
| [rust-inspector](https://github.com/aboutcode-org/rust-inspector) | Extract dependencies and symbols from Rust binaries | [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra) |
48+
Please visit the website for the most up-to-date and complete list of projects.
6949

70-
### Libraries
50+
---
7151

72-
| Project | Description | Maintainer |
73-
|---------|-------------|------------|
74-
| [license-expression](https://github.com/aboutcode-org/license-expression) | Parse, analyze, and normalize SPDX license expressions | [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra) |
75-
| [commoncode](https://github.com/aboutcode-org/commoncode) | Common utilities for paths, dates, files, and hashes | [@AyanSinhaMahapatra](https://github.com/AyanSinhaMahapatra) |
76-
| [extractcode](https://github.com/aboutcode-org/extractcode) | Universal archive extraction library and CLI tool | [@JonoYang](https://github.com/JonoYang) |
77-
| [fetchcode](https://github.com/aboutcode-org/fetchcode) | Reliably fetch code via HTTP, FTP, and version control systems | [@JonoYang](https://github.com/JonoYang) |
52+
## 🤝 Contributing
7853

79-
### Other Tools
54+
We welcome contributions! Whether you're:
8055

81-
| Project | Description | Maintainer |
82-
|---------|-------------|------------|
83-
| [aboutcode-toolkit](https://github.com/aboutcode-org/aboutcode-toolkit) | Document code provenance and generate attribution notices using ABOUT files | [@chinyeungli](https://github.com/chinyeungli) |
84-
| [univers](https://github.com/aboutcode-org/univers) | Parse and compare package versions across all ecosystems | [@TG1999](https://github.com/TG1999) |
85-
| [federatedcode](https://github.com/aboutcode-org/federatedcode) | Decentralized, federated metadata system for open source software | [@keshav-space](https://github.com/keshav-space) |
56+
- Fixing bugs 🐛
57+
- Adding features 🚀
58+
- Improving documentation 📚
8659

87-
### AboutCode Data
60+
We’d love your help.
8861

89-
AboutCode Data is a set of conventions for data structures that all AboutCode tools can use to exchange data. ABOUT files and ScanCode Toolkit data are examples of this approach, supporting projects like [libraries.io](https://libraries.io/) and [OSS Review Toolkit](https://github.com/heremaps/oss-review-toolkit).
62+
### Get Started:
9063

91-
## Standards and Related Projects
64+
- Read the `CONTRIBUTING.md` guide
65+
- Look for **good first issues**
66+
- Join the community chat
9267

93-
AboutCode is based on key industry standards and works closely with other FOSS organizations:
68+
---
9469

95-
### PURL (Package URL)
70+
## 📊 AboutCode Data
9671

97-
[PURL](https://github.com/package-url/purl-spec) is a URL string used to identify and locate software packages universally across programming languages, package managers, and tools. It originated from ScanCode and is in process to become an Ecma standard.
72+
AboutCode Data defines conventions for structured data exchange across tools.
9873

99-
**Maintainer**: [@johnmhoran](https://github.com/johnmhoran)
74+
Examples include:
75+
- ABOUT files
76+
- ScanCode Toolkit outputs
10077

101-
### VERS (Version Range Specification)
78+
This approach supports interoperability with tools like:
79+
- libraries.io
80+
- OSS Review Toolkit
10281

103-
VERS is an emerging specification for resolving dependency and vulnerable version ranges. It originated as part of the PURL project and is in process to become an Ecma standard.
82+
---
10483

105-
**Specification**: [VERSION-RANGE-SPEC.rst](https://github.com/package-url/purl-spec/blob/c29b870ab33382309eefee2a0975ef7f71fdb742/VERSION-RANGE-SPEC.rst)
84+
## 📐 Standards and Related Projects
10685

107-
### Related Organizations
86+
AboutCode is built on and contributes to key industry standards:
10887

109-
- [Package URL](https://github.com/package-url): A widely used standard to identify software packages with simple, readable URLs. See the [PURL discussions](https://github.com/package-url/purl-spec/discussions) for Ecma standardization details.
88+
### 🔹 PURL (Package URL)
89+
A universal way to identify software packages across ecosystems.
90+
Originated from ScanCode and progressing toward Ecma standardization.
11091

111-
- [SPDX](http://SPDX.org): System Package Data Exchange, a specification to document the origin and licensing of packages.
92+
### 🔹 VERS (Version Range Specification)
93+
A specification for defining dependency and vulnerability version ranges.
94+
(See `VERSION-RANGE-SPEC.rst`)
11295

113-
- [CycloneDX](https://cyclonedx.org): OWASP CycloneDX is a full-stack Bill of Materials (BOM) standard for supply chain security.
96+
---
97+
98+
## 🌍 Related Organizations
11499

115-
- [ClearlyDefined](https://ClearlyDefined.io): A project to help FOSS projects improve their licensing and documentation clarity (incubating with [opensource.org](https://opensource.org)).
100+
- SPDX – Software Package Data Exchange
101+
- CycloneDX – BOM standard for supply chain security
102+
- ClearlyDefined – Improves FOSS licensing clarity
116103

117104
---
118105

119-
**License**: Apache License 2.0 | **Code of Conduct**: [CODE_OF_CONDUCT.rst](CODE_OF_CONDUCT.rst)
106+
## 📜 License
107+
108+
- Apache License 2.0
109+
110+
## 📢 Code of Conduct
111+
112+
See: `CODE_OF_CONDUCT.rst`

0 commit comments

Comments
 (0)