LinguaPhylo / LPhyBeast

Convert LPhy scripts to BEAST 2 XML
GNU Lesser General Public License v2.1
3 stars 1 forks source link

Update README.md with updated command and hyperlink #157

Closed CSTE7007 closed 1 month ago

CSTE7007 commented 1 month ago

The section https://github.com/LinguaPhylo/LPhyBeast?tab=readme-ov-file#setup-and-usage

Create 10 BEAST 2 XMLs for a simple HKY+Coalescent simulation study: $BEAST_FOLDER/bin/lphybeast -r 10 examples/hkyCoalescent

that section currently undergoes significant changes

  1. HKY+Coalescent hyperlink is no longer available as the file path updated from https://github.com/LinguaPhylo/linguaPhylo/blob/master/examples/coalescent/hkyCoalescent.lphy to https://github.com/LinguaPhylo/linguaPhylo/blob/master/examples/coalescent/hkyCoalescent.lphy
  2. examples/hkyCoalescent directory structure changed to examples/coalescent/hkyCoalescent.lphy
  3. the file name examples/hkyCoalescent should be renamed examples/coalescent/hkyCoalescent.lphy with a (dot) .lphy extension.

Hence the updated section with updated hyperlink and command will be alike:

Create 10 BEAST 2 XMLs for a simple HKY+Coalescent simulation study: $BEAST_FOLDER/bin/lphybeast -r 10 examples/coalescent/hkyCoalescent.lphy

walterxie commented 1 month ago

Thank you for informing me. This RM is very outdated. I have directed that section to the user manual, which will be regularly updated.