gslab-econ/template

Make readme more user-friendly

Closed this issue · 4 comments

arosenbe commented

The readme has become a little messy, to the point where it's difficult to track and install dependencies. The goal of this task is to spruce up the readme.

arosenbe commented

@lboxell,

It doesn't look like all the statements in the readme are true, for example, homebrew is not the easiest way to install the Stata YAML parser. It seems like we might want to provide some more specific instructions for downloading, maybe adding the code in blocks.

lboxell commented

Fixed homebrew statement.

lboxell commented

I think we just want to point people to the source of the items being installed (e.g., we don't need to tell people how to install Lyx, Lyx should tell people how to install Lyx.).

lboxell commented

Closing task.

Summary:

  • Made readme more explicit about yaml dependencies.