slight update to README (still very early development/testing)

euctrl-pru · Jun 27, 2024 · 97b5580 · 97b5580
1 parent 1c06711
commit 97b5580
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 6 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -13,16 +13,21 @@ knitr::opts_chunk$set(
 )
 ```
 
-# ansperf
+# Operational ANS Performance with R
 
 <!-- badges: start -->
 <!-- badges: end -->
 
-The goal of ansperf is to ...
+The goal of `{ansperf}` is to provide a enable interested stakeholders to undertake a standardised operational performance analysis in accordance with the ICAO Global Air Navigation Plan and/or variants used by the international performance benchmarking community.
+
+The package is based on the work of the Performance Section of DECEA Brazil and the Performance Review Unit of EUROCONTROL. 
+
+This is an initial setup. Thus, the content is heavily under development.
+Please come back for any updates.
 
 ## Installation
 
-You can install the development version of ansperf from [GitHub](https://github.com/) with:
+You can install the development version of the `{ansperf}` package from [GitHub](https://github.com/) with:
 
 ``` r
 # install.packages("devtools")

diff --git a/README.md b/README.md
@@ -1,16 +1,25 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# ansperf
+# Operational ANS Performance with R
 
 <!-- badges: start -->
 <!-- badges: end -->
 
-The goal of ansperf is to …
+The goal of `{ansperf}` is to provide a enable interested stakeholders
+to undertake a standardised operational performance analysis in
+accordance with the ICAO Global Air Navigation Plan and/or variants used
+by the international performance benchmarking community.
+
+The package is based on the work of the Performance Section of DECEA
+Brazil and the Performance Review Unit of EUROCONTROL.
+
+This is an initial setup. Thus, the content is heavily under
+development. Please come back for any updates.
 
 ## Installation
 
-You can install the development version of ansperf from
+You can install the development version of the `{ansperf}` package from
 [GitHub](https://github.com/) with:
 
 ``` r

diff --git a/_xREADME-SETUP b/_xREADME-SETUP
@@ -33,6 +33,9 @@ setup packagedown
 * setup pkgdown workflow: usethis::use_pkgdown_github_pages()
 * usethis::use_readme_rmd()
 
+Edit your README.Rmd file
+Build your README.md file by running devtools::build_readme() in the R console
+
 create functions
 * usethis::use_r("function-name-file")
 * CTRL+SHIFT+b (to build package)