umccr / RNAsum

Pipeline for generating RNAseq-based cancer patient reports
https://umccr.github.io/RNAsum/
Other
7 stars 4 forks source link

Sync READMEs #159

Closed pdiakumis closed 3 months ago

pdiakumis commented 3 months ago

Need to exclusively work with README.Rmd and remember to render that to generate the README.md file.

pdiakumis commented 3 months ago

@skanwal if you set up https://github.com/lorenzwalthert/precommit on your local Mac you'll be able to utilise the hooks in https://github.com/umccr/RNAsum/blob/main/.pre-commit-config.yaml (the readme-rmd-rendered one will actually stop from committing if you have changed the Rmd and haven't changed the md - https://lorenzwalthert.github.io/precommit/articles/available-hooks.html#readme-rmd-rendered).