The purpose of the README is essentially to hook potential users with compelling informational about what and why machinist is. This same material should be presented at the beginning of the other documentation machinist comes with - the stuff in doc that will end up on readthedocs.org and be experienced by people discovering the project without going via the README.
The purpose of the README is essentially to hook potential users with compelling informational about what and why machinist is. This same material should be presented at the beginning of the other documentation machinist comes with - the stuff in
docthat will end up on readthedocs.org and be experienced by people discovering the project without going via the README.Suggested https://github.com/hybridcluster/machinist/pull/32#discussion-diff-13708117