Skip to content
This repository has been archived by the owner on Jul 2, 2019. It is now read-only.

Update README.md #103

Open
nrweir opened this issue Nov 27, 2018 · 0 comments
Open

Update README.md #103

nrweir opened this issue Nov 27, 2018 · 0 comments

Comments

@nrweir
Copy link
Collaborator

nrweir commented Nov 27, 2018

Update README.md

We need to read through the README carefully and see what is deprecated going from the "old" master to v3/dev. For example, the paths to some of the scripts referenced in the readme have changed, I'm not sure if the cli remains as it's described, etc.

Other tasks:

  • include install instructions relevant to 4.0.0
  • include links to readthedocs when that's live
  • include a "version history" section where we can indicate what has changed between releases (? this can also be done as its own .txt file in the repo if it will be too unwieldy)
  • probably more I'm not thinking of right now
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant