search

kassonlab / run_brer

Python package for running bias-resampling ensemble refinement (BRER) simulations
GNU Lesser General Public License v2.1
0 stars 3 forks source link

Reconcile index.rst with README.md #61

Open eirrgang opened 2 years ago

eirrgang commented 2 years ago

I just noticed that these have largely overlapping content, but have diverged with lack of attention to index.rst.

I'm not sure what the best solution is. If we want the content of README to be included in https://kassonlab.github.io/run_brer/, we could try to convert README.md to README.rst and inline it directly into index.rst.

If we want to keep them separate, we should consider whether some content should be deduplicated to reduce maintenance burden. But we might just need to do a better job of keeping both up-to-date.

Thoughts?

peterkasson commented 2 years ago

bump README.md looks very old right now. We should make sure it's up to date and describes current best practice for installation.

eirrgang commented 2 years ago

I believe this issue is resolved for https://github.com/kassonlab/brer-md

We can back port updates from https://github.com/kassonlab/brer-md/commit/07b7f394a4a1384e52dd6cd4bc0fb9813a3bb2a9 to the run_brer repository, if needed.