From 6d7f47b3afded07e5fd8af62f20143b49dde15ab Mon Sep 17 00:00:00 2001 From: Zoe Braiterman Date: Mon, 22 Jan 2024 17:30:30 -0500 Subject: [PATCH 1/5] Apply the Carpentries lesson outline to the README file. --- README.md | 57 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 35 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 60ddf021..cb51f00e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,24 @@ -# The Carpentries Workbench Template R Markdown Lesson +# R Geospatial Urban This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. -## Create a new repository from this template +## Lesson Description -To use this template to start a new lesson repository, -make sure you're logged into Github. +## Rendered Version of This Lesson + +## Contact Information + +## Contributing Information + +## Credits / Acknowledgements + +## Citation + +## License + +To use this template to +start a new lesson repository, +make sure you're logged into Github. Visit https://github.com/carpentries/workbench-template-rmd/generate and follow the instructions. Checking the 'Include all branches' option will save some time waiting for the first website build @@ -13,7 +26,7 @@ when your new repository is initialised. If you have any questions, contact [@zkamvar](https://github.com/zkamvar) -## Configure a new lesson +## Rendered Version of This Lesson Follow the steps below to complete the initial configuration of a new lesson repository built from this template: @@ -36,7 +49,7 @@ complete the initial configuration of a new lesson repository built from this te - `contact` 1. **Annotate the repository** with site URL and topic tags: navigate back to the repository landing page and - click on the gear wheel/cog icon (similar to ⚙️) + click on the gear wheel/cog icon (similar to ⚙️) at the top-right of the _About_ box. Check the "Use your GitHub Pages website" option, and [add some keywords and other annotations to describe your lesson](https://cdh.carpentries.org/the-carpentries-incubator.html#topic-tags) @@ -47,24 +60,24 @@ complete the initial configuration of a new lesson repository built from this te - the human language the lesson is written in (e.g. `deutsch`) 1. **Adjust the name of the `.Rproj` file.** It is simplest to make this match the name of the repository. -1. **Adjust the +1. **Adjust the `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and `LICENSE.md` files** as appropriate for your project. - - `CODE_OF_CONDUCT.md`: - if you are using this template for a project outside The Carpentries, - you should adjust this file to describe - who should be contacted with Code of Conduct reports, - and how those reports will be handled. - - `CONTRIBUTING.md`: - depending on the current state and maturity of your project, - the contents of the template Contributing Guide may not be appropriate. - You should adjust the file to help guide contributors on how best - to get involved and make an impact on your lesson. - - `LICENSE.md`: - in line with the terms of the CC-BY license, - you should ensure that the copyright information - provided in the license file is accurate for your project. -1. **Update this README with + - `CODE_OF_CONDUCT.md`: + if you are using this template for a project outside The Carpentries, + you should adjust this file to describe + who should be contacted with Code of Conduct reports, + and how those reports will be handled. + - `CONTRIBUTING.md`: + depending on the current state and maturity of your project, + the contents of the template Contributing Guide may not be appropriate. + You should adjust the file to help guide contributors on how best + to get involved and make an impact on your lesson. + - `LICENSE.md`: + in line with the terms of the CC-BY license, + you should ensure that the copyright information + provided in the license file is accurate for your project. +1. **Update this README with [relevant information about your lesson](https://carpentries.github.io/lesson-development-training/collaborating-newcomers.html#readme)** and delete this section. From e11a10fd9ea2c1f676611de437fc51680d7636e7 Mon Sep 17 00:00:00 2001 From: Zoe Braiterman Date: Mon, 22 Jan 2024 17:49:16 -0500 Subject: [PATCH 2/5] Update the README file. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index cb51f00e..204ab6e6 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,26 @@ This lesson is a template lesson that uses [The Carpentries Workbench][workbench ## Rendered Version of This Lesson +Version 1.0 + ## Contact Information +[Claudiu Forgaci](https://github.com/cforgaci) + ## Contributing Information +Please see the [CONTRIBUTING page](https://github.com/carpentries-incubator/r-geospatial-urban/blob/main/CONTRIBUTING.md) for guidance on how to contribute to this lessom. + ## Credits / Acknowledgements +- [Claudiu Forgaci](https://github.com/cforgaci) + ## Citation ## License +The R Geospatial Urban lesson, like most other software provided by The Carpentries, are made available under the OSI-approved MIT license. Please see the [LICENSE page](https://github.com/carpentries-incubator/r-geospatial-urban/blob/main/LICENSE.md) for further information. + To use this template to start a new lesson repository, make sure you're logged into Github. From 392191d60ba7a0a8fcbd7a2d3acd175e5f4011de Mon Sep 17 00:00:00 2001 From: Claudiu Forgaci <33600128+cforgaci@users.noreply.github.com> Date: Mon, 29 Jan 2024 13:54:02 +0100 Subject: [PATCH 3/5] Update list of contributors in README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 204ab6e6..04c3a94c 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,15 @@ Please see the [CONTRIBUTING page](https://github.com/carpentries-incubator/r-ge ## Credits / Acknowledgements +- [Daniele Cannatella](https://github.com/dcannatella) +- [Clémentine Cottineau](https://github.com/ClementineCttn) - [Claudiu Forgaci](https://github.com/cforgaci) +- [Jerome Francisco Conceicao](https://github.com/fcjerome) +- [Manuel Garcia](https://github.com/manuGil) +- [Kyri Janssen](https://github.com/KyriJanssen) +- [Selin Kubilay](https://github.com/Selkubi) +- [Ana Petrovic](https://github.com/ana-5r) +- [Aleksandra Wilczynska](https://github.com/alwil) ## Citation From 7a62ee217a4a690cb9d32d984ae3edcdd8476ad2 Mon Sep 17 00:00:00 2001 From: Claudiu Forgaci <33600128+cforgaci@users.noreply.github.com> Date: Mon, 29 Jan 2024 16:25:58 +0100 Subject: [PATCH 4/5] Update title in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04c3a94c..aa6ce60d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# R Geospatial Urban +# Geospatial Data Carpentry for Urbanism This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. From 578e44b76acaf8d034722d64d22ec93f2c460f0a Mon Sep 17 00:00:00 2001 From: Claudiu Forgaci <33600128+cforgaci@users.noreply.github.com> Date: Mon, 29 Jan 2024 16:26:11 +0100 Subject: [PATCH 5/5] Update contact information in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aa6ce60d..ddd78a53 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Version 1.0 ## Contact Information -[Claudiu Forgaci](https://github.com/cforgaci) +[Rbanism Community](mailto:rbanism@tudelf.nl) ## Contributing Information