Skip to content

Commit

Permalink
doc: add cran badge & edit package description
Browse files Browse the repository at this point in the history
  • Loading branch information
ahasverus committed Apr 4, 2024
1 parent 7190ba4 commit f493fe3
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 10 deletions.
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ type: software
license: GPL-2.0-or-later
title: 'planner: Create Ready to Print Calendars'
version: '0.1'
abstract: Plots and exports a monthly calendar as 'pdf'. Holidays (France only) are
identified. User can easily add events (up to four by day) and choose between of
a week of five days (working week) or a full week (weekend included).
abstract: 'Creates annual, monthly, and weekly calendars as PDF files in the A4 paper
format. Various information can be added: events, holidays, special days, moon phases,
etc.'
authors:
- family-names: Casajus
given-names: Nicolas
Expand Down
7 changes: 3 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ Authors@R: c(
role = c("aut", "cre", "cph"),
email = "nicolas.casajus@fondationbiodiversite.fr",
comment = c(ORCID = "0000-0002-5537-5294")))
Description: Plots and exports a monthly calendar as 'pdf'. Holidays (France
only) are identified. User can easily add events (up to four by day) and
choose between of a week of five days (working week) or a full week
(weekend included).
Description: Creates annual, monthly, and weekly calendars as PDF files in the
A4 paper format. Various information can be added: events, holidays,
special days, moon phases, etc.
URL: https://github.com/frbcesab/planner
BugReports: https://github.com/frbcesab/planner/issues
License: GPL (>= 2)
Expand Down
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ planner <img src="man/figures/logo.png" align="right" style="float:right; height
=========================================================

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/planner)](https://CRAN.R-project.org/package=planner)
[![R CMD Check](https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml)
[![License: GPL (>= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

<!-- badges: start -->

[![CRAN
status](https://www.r-pkg.org/badges/version/planner)](https://CRAN.R-project.org/package=planner)
[![R CMD
Check](https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml)
Expand Down
4 changes: 2 additions & 2 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "planner",
"description": "Plots and exports a monthly calendar as 'pdf'. Holidays (France only) are identified. User can easily add events (up to four by day) and choose between of a week of five days (working week) or a full week (weekend included).",
"description": "Creates annual, monthly, and weekly calendars as PDF files in the A4 paper format. Various information can be added: events, holidays, special days, moon phases, etc.",
"name": "planner: Create Ready to Print Calendars",
"codeRepository": "https://github.com/frbcesab/planner",
"issueTracker": "https://github.com/frbcesab/planner/issues",
Expand Down Expand Up @@ -138,7 +138,7 @@
},
"SystemRequirements": null
},
"fileSize": "1272.638KB",
"fileSize": "1272.626KB",
"citation": [
{
"@type": "SoftwareSourceCode",
Expand Down
2 changes: 1 addition & 1 deletion man/planner-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f493fe3

Please sign in to comment.