Skip to content
This repository has been archived by the owner on Jul 23, 2023. It is now read-only.

README: Add relevant information #8

Closed
maurolepore opened this issue Sep 21, 2018 · 1 comment
Closed

README: Add relevant information #8

maurolepore opened this issue Sep 21, 2018 · 1 comment

Comments

@maurolepore
Copy link
Contributor

From @maurolepore on September 18, 2018 14:46

I believe you already created the skeleton of a readme file with usethis::use_readme_rmd(). It doesn't yet appear on GitHub, meaning that you haven't pushed it yet.

The information in README will appear at the Home of the package website, and also on the front page of your package repository. README should cover the goal of the package, installation instructions, and an example. Remember to knit that .Rmd file whenever you update it. That will generate a .md version. Don't edit the .md version; edit the .Rmd only.

Copied from original issue: ErvanCH/AGBflux_pack#5
@maurolepore maurolepore mentioned this issue Sep 21, 2018
Closed
@maurolepore maurolepore changed the title Add a README file. README: Add relevant information Sep 21, 2018
maurolepore added a commit that referenced this issue Sep 21, 2018
@maurolepore
#8: Add readme. @ervanSTRI: Please fill the relevant information.
6733fa3
@maurolepore maurolepore mentioned this issue Sep 21, 2018
Closed
@maurolepore
Copy link
Contributor Author

@ervanSTRI , notice that I added an example that showcases the entire functionality I am aware of. If there is more to this package, please show it in README. And feel free to edit what I wrote.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@maurolepore