Skip to content

Commit 6c198f7

Browse files
maelleyabellinimpadge
authored
README section tweaks (#761)
* README section tweaks * Update pkg_building.es.Rmd Co-authored-by: Yanina Bellini Saibene <[email protected]> * Update pkg_building.Rmd * Update pkg_building.Rmd Co-authored-by: mark padgham <[email protected]> * align Spanish text to English text * Update pkg_building.es.Rmd --------- Co-authored-by: Yanina Bellini Saibene <[email protected]> Co-authored-by: mark padgham <[email protected]>
1 parent bacc85e commit 6c198f7

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

pkg_building.Rmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ bibentry(
150150
- All packages should have a README file, named `README.md`, in the root of the repository. The README should include, from top to bottom:
151151

152152
- The package name.
153-
- Badges for continuous integration and test coverage, the badge for rOpenSci peer-review once it has started (see below), a repostatus.org badge, and any other badges (e.g. [R-universe](https://ropensci.org/blog/2021/10/14/runiverse-badges/)). If the README has many more badges, you might want to consider using a table for badges, see [this example](https://github.com/ropensci/ijtiff#ijtiff-), [that one](https://github.com/ropensci/drake) and [that one](https://github.com/ropensci/qualtRics/). Such a table should be more wide than high.
154-
- Short description of goals of package, with descriptive links to all vignettes (rendered, i.e. readable, cf [the documentation website section](#website)) unless the package is small and there's only one vignette repeating the README.
153+
- Badges for continuous integration and test coverage, the badge for rOpenSci peer-review once it has started (see below), a repostatus.org badge, and any other badges (e.g. [R-universe](https://ropensci.org/blog/2021/10/14/runiverse-badges/)).
154+
- Short description of goals of package (what does it do? why should a potential user care?), with descriptive links to all vignettes unless the package is small and there's only one vignette repeating the README. Please also ensure the vignettes are rendered and readable, see [the "documentation website" section](#website)).
155155
- Installation instructions using e.g. the [remotes package](https://remotes.r-lib.org/), [pak package](https://pak.r-lib.org/), or [R-universe](https://ropensci.org/blog/2021/06/22/setup-runiverse/).
156156
- Any additional setup required (authentication tokens, etc).
157157
- Brief demonstration usage.

pkg_building.es.Rmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,8 @@ bibentry(
155155
El *README* debe incluir, en este orden:
156156

157157
- El nombre del paquete.
158-
- Etiquetas de integración continua y la cobertura de tests, la etiqueta de revisión por pares de rOpenSci una vez que haya comenzado (ver más abajo), una etiqueta de repostatus.org, y cualquier otra (por ejemplo [R-universe](https://ropensci.org/blog/2021/10/14/runiverse-badges/)). Si el *README* tiene muchas etiquetas, puedes considerar el uso de una tabla de etiquetas (ver [este ejemplo](https://github.com/ropensci/ijtiff#ijtiff-), [este otro](https://github.com/ropensci/drake) o [este otro](https://github.com/ropensci/qualtRics/)). Esta tabla debe ser más ancha que alta.
159-
- Una breve descripción de los objetivos del paquete con enlaces descriptivos a todas las viñetas (renderizadas, es decir, legibles, por ejemplo [el sitio web de documentación](#website)) a menos que el paquete sea pequeño y sólo haya una viñeta que repita el *README*.
158+
- Etiquetas de integración continua y la cobertura de tests, la etiqueta de revisión por pares de rOpenSci una vez que haya comenzado (ver más abajo), una etiqueta de repostatus.org, y cualquier otra (por ejemplo [R-universe](https://ropensci.org/blog/2021/10/14/runiverse-badges/)).
159+
- Una breve descripción de los objetivos del paquete (¿qué hace? ¿por qué seria interesante usarlo?) con enlaces descriptivos a todas las viñetas (renderizadas, es decir, legibles, por ejemplo [el sitio web de documentación](#website)) a menos que el paquete sea pequeño y sólo haya una viñeta que repita el *README*. Asegúrate también de que las viñetas estén renderizadas y sean legibles, consulta [la sección "sitio web de documentación"](#website)).
160160
- Instrucciones de instalación utilizando, por ejemplo, el paquete [remotes](https://remotes.r-lib.org/), [pak](https://pak.r-lib.org/) o [R-universe](https://ropensci.org/blog/2021/06/22/setup-runiverse/).
161161
- Cualquier configuración adicional necesaria (tokens de autenticación, etc).
162162
- Una breve demostración de uso.

0 commit comments

Comments
 (0)