Merge pull request #117 from nhs-r-community/readme-template

Readme template
nhs-r-community · May 13, 2024 · f585c1a · f585c1a
2 parents 98a3a4d + 61bb52a
commit f585c1a
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/style-guides.qmd b/style-guides.qmd
@@ -169,7 +169,22 @@ The use of the package {lintr} is also highly recommended and can show particula
 
 # READMEs in repositories
 
-As standard all NHS-R GitHub repository READMEs should include the following text that refers to the Code of Conduct in this book:
+
+As standard all NHS-R GitHub repository READMEs should include the following text: 
+
+```
+# Installation 
+
+You can install the current version of {name of pacakge} from GitHub with:
+```
+```{r}
+#| eval: false
+#| echo: fenced
+
+# install.packages("remotes")
+remotes::install_github("nhs-r-community/name-of-package")
+
+```
 
 ```
 ## Contributing