search

macroevolution / bamm

A program for multimodel inference on speciation and trait evolution
GNU General Public License v2.0
33 stars 10 forks source link

Final sphinx documentation for pre-release #66

Closed drabosky closed 10 years ago

drabosky commented 10 years ago

I finished most of the sphinx documentation including a significant overhaul to quick-start guide to really make it quick start. Most or all embedded links should now be active. R code all updated, etc.

What remains is:

Section 4, setting up BAMM w installation issues etc and anything else on there that needs done.

Section 8, Problems Running BAMM section. Especially for problems with installation, etc.

redcurry commented 10 years ago

BAMM binaries can be downloaded for OS X or Windows. There are instructions on how to install these files in each operating system.

redcurry commented 10 years ago

Section 8 probably needs to be renamed. It would be nice to have a FAQ section, but this should only contain questions and answers. Perhaps FAQ and Problems should be separated, otherwise you get a mix of questions about the science and how to use BAMM vs. questions about installation issues, crashes, etc.

redcurry commented 10 years ago

I have created a Troubleshooting page for problems installing and running BAMM. There is also a section for problems with analyses, like whether the MCMC has converged (but there is no answer). I have kept the FAQ page, but I have moved the sections on problems to the Troubleshooting page. We should probably make the FAQ page be composed of questions to make it consistent.