Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

- Improve readme and add getting started vignette (#44, @sharlagelfand). #44

Merged
merged 13 commits into from Jan 31, 2020

Conversation

sharlagelfand
Copy link
Contributor

Improve README by adding:

Also added a "Getting Started" vignette which contains most of the same information as the README, but also further details on using here (and why we want to) in an Rmd in a subdirectory.

I assume you'll want to re-render the README so that it doesn't contain the file path to my tidy dev day folder. I'm a little fuzzy on where things (especially the pkgdown docs) might be off since @krlmlr has been making changes to the package while i've been working on it, but happy to work through it.

Closes #42

@codecov-io
Copy link

codecov-io commented Jan 31, 2020

Codecov Report

Merging #44 into master will not change coverage.
The diff coverage is 17.39%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #44   +/-   ##
=======================================
  Coverage   11.11%   11.11%           
=======================================
  Files           4        4           
  Lines          36       36           
=======================================
  Hits            4        4           
  Misses         32       32
Impacted Files Coverage Δ
R/here.R 0% <ø> (ø) ⬆️
R/aaa.R 0% <0%> (ø) ⬆️
R/zzz.R 16.66% <16.66%> (ø) ⬆️
R/here-dr.R 30% <30%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7abfd76...e8507b9. Read the comment docs.

Copy link
Member

@krlmlr krlmlr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks much better, thanks!

Can you please rescale the image to 1400 pixels wide?

DESCRIPTION Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
sharlagelfand and others added 3 commits January 31, 2020 14:28
@sharlagelfand
Copy link
Contributor Author

thanks, fixed the illustration size + ref!

@krlmlr krlmlr changed the title Improve readme and add getting started vignette - Improve readme and add getting started vignette (#44, @sharlagelfand). Jan 31, 2020
@krlmlr krlmlr merged commit 29bfa2e into r-lib:master Jan 31, 2020
@krlmlr
Copy link
Member

krlmlr commented Jan 31, 2020

Thanks! The docs are in much better shape now!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 31, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve README, add "Get Started" article
3 participants