From 3feb7c4228098430ec02e8ff21c136d9b4f9eb48 Mon Sep 17 00:00:00 2001 From: harell Date: Sun, 2 Jun 2019 11:54:05 +1200 Subject: [PATCH] updated readme --- README.Rmd | 18 +++++++++++------- README.md | 18 +++++++++++------- 2 files changed, 22 insertions(+), 14 deletions(-) diff --git a/README.Rmd b/README.Rmd index a839888..81d760f 100644 --- a/README.Rmd +++ b/README.Rmd @@ -52,19 +52,23 @@ covr_url <- paste0("https://codecov.io/gh/tidylab/", project_name, "/branch/mast ## Useage -1. Clone ``r project_name`` +1. Create a new repo on GitHub. 2. Use the [`git-flow`](https://blog.sourcetreeapp.com/2012/08/01/smart-branching-with-sourcetree-and-git-flow/) approach in your development cycle. -3. Change the `tidylab.boilerplate.Rproj` file to `.Rproj`. -4. Open the `DESCRIPTION` file, and edit the following fields: +3. Create a new release named `inception`. +4. Copy ``r project_name`` content to the new reposetory. +5. Change the `tidylab.boilerplate.Rproj` file to `.Rproj`. +6. Open the `DESCRIPTION` file, and edit the following fields: 1. **Package** modify the package name while using the `tidylab.` prefix. 2. **Title** modify the package title; use uppercase words with no period ('.'). 3. **URL** modify the package URL such that it leads to its GitHub repo. 3. **BugReports** edit the URL such that it leads to the package issue page. 4. **Description** modify the package decription. -5. In `README.Rmd` delete the **Useage** Section. -6. Render `README.Rmd` by clicking the **Knit** button. -7. Setup CI/CD on [Travis](https://travis-ci.org/tidylab). -8. Cover the project on [codecov](https://codecov.io/github/tidylab). +7. In `README.Rmd` delete the **Useage** Section. +8. Render `README.Rmd` by clicking the **Knit** button. +9. Push changed on the `inception` branch. +10. Setup CI/CD by running`usethis::use_travis()`. +11. Revert changes made on `.travis.yml`. +12. Cover the project on [codecov](https://codecov.io/github/tidylab). ## Installation diff --git a/README.md b/README.md index 2698efa..ae4307e 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,15 @@ reduces unnecessary variance between packages configurations. ## Useage -1. Clone `tidylab.boilerplate` +1. Create a new repo on GitHub. 2. Use the [`git-flow`](https://blog.sourcetreeapp.com/2012/08/01/smart-branching-with-sourcetree-and-git-flow/) approach in your development cycle. -3. Change the `tidylab.boilerplate.Rproj` file to +3. Create a new release named `inception`. +4. Copy `tidylab.boilerplate` content to the new reposetory. +5. Change the `tidylab.boilerplate.Rproj` file to `.Rproj`. -4. Open the `DESCRIPTION` file, and edit the following fields: +6. Open the `DESCRIPTION` file, and edit the following fields: 1. **Package** modify the package name while using the `tidylab.` prefix. 2. **Title** modify the package title; use uppercase words with no @@ -42,10 +44,12 @@ reduces unnecessary variance between packages configurations. 4. **BugReports** edit the URL such that it leads to the package issue page. 5. **Description** modify the package decription. -5. In `README.Rmd` delete the **Useage** Section. -6. Render `README.Rmd` by clicking the **Knit** button. -7. Setup CI/CD on [Travis](https://travis-ci.org/tidylab). -8. Cover the project on [codecov](https://codecov.io/github/tidylab). +7. In `README.Rmd` delete the **Useage** Section. +8. Render `README.Rmd` by clicking the **Knit** button. +9. Push changed on the `inception` branch. +10. Setup CI/CD by running`usethis::use_travis()`. +11. Revert changes made on `.travis.yml`. +12. Cover the project on [codecov](https://codecov.io/github/tidylab). ## Installation