From c234be956a8099c81939471f7c0b4fb00100df28 Mon Sep 17 00:00:00 2001 From: Eyal Rozenberg Date: Mon, 23 Sep 2024 14:54:06 +0300 Subject: [PATCH] Using shields in README.md: * Add build status and license shields * converted documentation to a shield link only * Renamed workflows for shortening the shield label --- .github/workflows/cmake-build-linux.yml | 2 +- .github/workflows/cmake-build-windows.yml | 2 +- README.md | 11 ++++++----- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/workflows/cmake-build-linux.yml b/.github/workflows/cmake-build-linux.yml index 392ffdce..22cdb9f1 100644 --- a/.github/workflows/cmake-build-linux.yml +++ b/.github/workflows/cmake-build-linux.yml @@ -1,4 +1,4 @@ -name: CMake-based build on (Ubuntu) Linux +name: Builds on (Ubuntu) Linux on: workflow_dispatch: diff --git a/.github/workflows/cmake-build-windows.yml b/.github/workflows/cmake-build-windows.yml index afeafe56..70ab6b5a 100644 --- a/.github/workflows/cmake-build-windows.yml +++ b/.github/workflows/cmake-build-windows.yml @@ -1,4 +1,4 @@ -name: CMake-based build on Windows +name: Builds on Windows on: workflow_dispatch: diff --git a/README.md b/README.md index 57ff7265..649426de 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,15 @@ +[![Repository license](https://img.shields.io/badge/License-3BSD-blue.svg)](https://raw.githubusercontent.com/eyalroz/cuda-api-wrappers/master/LICENSE) +[![Repository documentation](https://img.shields.io/badge/Documentation-CodeDocs-blue.svg)](https://codedocs.xyz/eyalroz/cuda-api-wrappers/) +[![Linux build passing](https://github.com/eyalroz/cuda-api-wrappers/actions/workflows/cmake-build-linux.yml/badge.svg)](https://github.com/eyalroz/cuda-api-wrappers/actions/workflows/cmake-build-linux.yml) +[![Windows build passing](https://github.com/eyalroz/cuda-api-wrappers/actions/workflows/cmake-build-windows.yml/badge.svg)](https://github.com/eyalroz/cuda-api-wrappers/actions/workflows/cmake-build-windows.yml) + | Table of contents | |:------------------| -|[General description](#general-description)
- [Key features](#key-features)
[Motivation](#motivation)
[Detailed documentation](#detailed-documentation)
[Requirements](#requirements)
[Using the library in your project](#using-the-library-in-your-project)
[Coverage of the APIs](#coverage-of-the-apis)
[A taste of some features in play](#a-taste-of-some-features-in-play)
[Example programs](#example-programs)
- [Modified CUDA samples](#modified-cuda-samples)
- ['Coverage' programs - by API module](#coverage-programs---by-api-module)
[Want to help? Report a bug? Give feedback?](#want-to-help-report-a-bug-give-feedback)| +|[General description](#general-description)
- [Key features](#key-features)
[Motivation](#motivation)
[Requirements](#requirements)
[Using the library in your project](#using-the-library-in-your-project)
[Coverage of the APIs](#coverage-of-the-apis)
[A taste of some features in play](#a-taste-of-some-features-in-play)
[Example programs](#example-programs)
- [Modified CUDA samples](#modified-cuda-samples)
- ['Coverage' programs - by API module](#coverage-programs---by-api-module)
[Want to help? Report a bug? Give feedback?](#want-to-help-report-a-bug-give-feedback)| ## General description @@ -65,10 +70,6 @@ Driver API. These suffer from several deficiencies: You may have noticed this list reads like the opposite of the [key features](#key-features), listed above: The idea is to make this library overcome and rectify all of these deficiencies as much as possible. -## Detailed documentation - -Detailed Doxygen-genereated documentation is [available](https://codedocs.xyz/eyalroz/cuda-api-wrappers/). It is mostly complete; please file a bug if an API function is missing or under-documented. - ## Requirements - CUDA: v11.x or later recommended, v9.0 or later supported.