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

README Page #11

Open
iqis opened this issue Apr 30, 2019 · 2 comments
Open

README Page #11

iqis opened this issue Apr 30, 2019 · 2 comments
Labels
low priority Meta-work Description, README, CI, documentation, test
Projects

Comments

@iqis
Copy link
Contributor

iqis commented Apr 30, 2019

create a README page with:

Package name, Badges

Brief Introduction

Installation instructions

Minimal working code example (pick one use case)

TODO

License

@iqis iqis self-assigned this May 2, 2019
@iqis
Copy link
Contributor Author

iqis commented May 6, 2019

A README skeleton is initialized in #16

@wendtke wendtke added this to To do in psyphr May 27, 2019
@wendtke wendtke moved this from To do to In progress in psyphr May 27, 2019
@iqis iqis added the Meta-work Description, README, CI, documentation, test label Jun 25, 2019
@wendtke wendtke mentioned this issue Jul 1, 2019
@wendtke
Copy link
Owner

wendtke commented Jul 9, 2019

Consider connecting the README to packagedocs vignettes and user guide. See #15 and Google Drive with GBA notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
low priority Meta-work Description, README, CI, documentation, test
Projects
psyphr
  
In progress
Development

No branches or pull requests

2 participants