create basic readme template - Githubissues

opentsi / deloRean

R Package to Facilitate Administration of the Open Time Series Initiative (Experimental)

2 stars 0 forks source link

create basic readme template #4

Open mbannert opened 3 months ago

mbannert commented 3 months ago

Create a README.md file based on a template (lives in inst/)

[ ] installation instructions for opentimeseries
[ ] data consumption instructions using opentimeseries, ideally using data from the data package that is created (when too complicated simply use opentsi/demo
[ ] Title based on archive_name
[ ] description of the dataset, queried from a description parameter that has to be added to archive_init.

hint: maybe whisker package is helpful for handling placeholder (maybe also glue).