Skip to content

Readme update #213

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.

Sign up for GitHub

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

Merged
JanCBrammer merged 2 commits into from
May 4, 2026
Merged

Readme update #213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41f9c4a
docs: add code quality section with Coverity and OSS-Fuzz to README.md
fbaensch-beilstein Apr 30, 2026
3b44f3f
docs: add legacy SourceForge tickets section to README.md
fbaensch-beilstein Apr 30, 2026
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[![Good reads](https://img.shields.io/badge/Goodreads-372213?style=flat&logo=goodreads&logoColor=white)](https://www.inchi-trust.org/inchi-overview-papers-presentations/?wpv_aux_current_post_id=4309&wpv_aux_parent_post_id=4309&wpv_view_count=4473)
[![InChI - Web Demo](https://img.shields.io/badge/InChI-Web_Demo-2ea44f)](https://iupac-inchi.github.io/InChI-Web-Demo/)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/32621/badge.svg)](https://scan.coverity.com/projects/inchi)
[![OSS-Fuzz Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/inchi.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?q=inchi)
[![SourceForge Issues](https://img.shields.io/badge/SourceForge-Issues-orange?logo=sourceforge)](https://sourceforge.net/p/inchi/_list/tickets/)

<img src="./INCHI-1-DOC/assets/inchi-wheel.png" width="300" height="300" />

Expand Down Expand Up @@ -57,6 +59,10 @@ You are welcome to contribute to this project. To do so, you may [submit a pull

![git-flow](./INCHI-1-DOC/assets/git_flow.svg)

## Legacy SourceForge tickets

Prior to the migration to GitHub, bug reports and feature requests for InChI were tracked on SourceForge. The archive of these old tickets is available at the [InChI SourceForge issue tracker](https://sourceforge.net/p/inchi/_list/tickets/) and may be useful as a historical reference. Please use the [GitHub issue tracker](https://github.com/IUPAC-InChI/InChI/issues) for new reports.

## Source code documentation

We've started documenting the source code with [Doxygen](https://www.doxygen.nl/index.html).
Expand Down Expand Up @@ -87,6 +93,16 @@ For details see <https://www.doxygen.nl/manual>.
The documentation is [built on every push](.github/workflows/deploy_docs.yml) to the default branch of this repository and hosted at <https://iupac-inchi.github.io/InChI/>.
That is, your comments will automatically be rendered to HTML and served as online documentation.

## Code quality

### Coverity static analysis

InChI is integrated into [Coverity Scan](https://scan.coverity.com/projects/inchi) for continuous static analysis.

### OSS-Fuzz continuous fuzzing

InChI is integrated into [Google OSS-Fuzz](https://github.com/google/oss-fuzz/tree/master/projects/inchi), which runs continuous fuzz testing against the library. Fuzzing-related bugs are tracked at the [OSS-Fuzz issue tracker](https://bugs.chromium.org/p/oss-fuzz/issues/list?q=inchi).

## Contents of this repository

### INCHI-1-DOC
Expand Down