Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Point to the documentation from the top of the README #661

Merged
merged 2 commits into from
Sep 5, 2024
Merged

Point to the documentation from the top of the README #661

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b1d91e
Point to the documentation from the top of the README
tmadlener Sep 5, 2024
96bdc5c
Add badge with links to doc
tmadlener Sep 5, 2024
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
15 changes: 4 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,13 @@
[![linux](https://github.com/AIDASoft/podio/actions/workflows/test.yml/badge.svg)](https://github.com/AIDASoft/podio/actions/workflows/test.yml)
[![ubuntu](https://github.com/AIDASoft/podio/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/AIDASoft/podio/actions/workflows/ubuntu.yml)
[![coverity](https://scan.coverity.com/projects/22634/badge.svg)](https://scan.coverity.com/projects/aidasoft-podio)
[![docs](https://img.shields.io/badge/docs-master-blue.svg)](https://key4hep.web.cern.ch/podio/)

## Documentation

- [Introduction](./doc/doc.md)
- [Design](./doc/design.md)
- [Data Model Syntax](./doc/datamodel_syntax.md)
- [Examples](./doc/examples.md)
- [Advanced Topics](./doc/advanced_topics.md)
- [Python Interface](./doc/python.md)
- [Contributing](./doc/contributing.md)

<!-- Browse the API documentation created with Doxygen at -->

<!-- [http://fccsw.web.cern.ch/fccsw/podio/index.html](http://fccsw.web.cern.ch/fccsw/podio/index.html). -->
The full documentation can be found at
[**key4hep.web.cern.ch/podio**](https://key4hep.web.cern.ch/podio/index.html). You
can also find an API reference there.

## Prerequisites

Expand Down
Loading