docs: CITATION.cff file added

This commit is contained in:
Mateusz Pusz
2021-11-04 11:17:22 +01:00
parent 8b28a0c6b9
commit 66fc906558
2 changed files with 80 additions and 0 deletions

34
.github/workflows/citation.yml vendored Normal file
View File

@ -0,0 +1,34 @@
name: CITATION.cff
on:
push:
paths:
- CITATION.cff
jobs:
Validate-CITATION-cff:
runs-on: ubuntu-latest
name: Validate CITATION.cff
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
RSPM: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"
steps:
- name: Checkout
uses: actions/checkout@v2
# This is needed for workflows running on
# ubuntu-20.04 or later
- name: Install V8
if: runner.os == 'Linux'
run: |
sudo apt-get install -y libv8-dev
- name: Validate CITATION.cff
uses: dieghernan/cff-validator@main
# Upload artifact
- uses: actions/upload-artifact@v2
if: failure()
with:
name: citation-cff-errors
path: citation_cff_errors.md

46
CITATION.cff Normal file
View File

@ -0,0 +1,46 @@
cff-version: 1.2.0
message: "If you use this software, please cite it using these metadata."
title: mp-units
abstract: >-
A compile-time enabled Modern C++ library that provides compile-time
dimensional analysis and unit/quantity manipulation.
keywords:
- c++
- library
- dimensional-analysis
- system-of-units
- units
- quantities
- physical-quantities
- physical-units
- units-of-measurement
- quantity-manipulation
type: software
license: MIT
# The below lists individual authors that contributed at least 50 commits to the source code repository.
# The rest of project's contributors are collectively referred to as "The mp-units project team".
authors:
- given-names: Mateusz
family-names: Pusz
orcid: https://orcid.org/0000-0003-0680-0765
- given-names: "Johel Ernesto"
family-names: "Guerrero Peña"
- name: "The mp-units project team"
contact:
- email: mateusz.pusz@gmail.com
given-names: Mateusz
family-names: Pusz
repository-code: 'https://github.com/mpusz/units'
url: 'https://mpusz.github.io/units'
repository-artifact: 'https://conan.io/center/mp-units'
version: 0.7.0
date-released: "2021-05-11"
identifiers:
- description: "The GitHub release URL of tag 0.7.0"
type: url
value: "https://github.com/mpusz/units/releases/tag/v0.7.0"