Update Readme.md and documentation with helpful info#434
Update Readme.md and documentation with helpful info#434derrickstolee merged 3 commits intomicrosoft:mainfrom
Conversation
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
jeffhostetler
left a comment
There was a problem hiding this comment.
I made a few suggestions, but very nice! Thanks!
mjcheetham
left a comment
There was a problem hiding this comment.
Looks good overall! I would only echo what @jeffhostetler has already said.
On the src point, I best not comment since my view here is we shouldn't be doing this at all 😁
We shouldn't be forcing a practice on people - they should change to adopt the practice, or take the file scanning perf hit anyway. (whoops.. I commented)
You're right, we should allow people to opt-out with a |
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
6fe6d6d to
df2f06e
Compare
Our Readme.md file is not incredibly helpful. We have changed a lot about our install/upgrade strategy, particularly for macOS. I have fielded several questions about this over email or in issues (e.g. #399).
This PR is a start to revamping our documentation a bit. The Readme now points to the more involved
docs/index.md. That directory also gets a "Philosophy of Scalar" document, which I will point to people who are wondering if Scalar is right for them.You can see how this Readme looks at the front page of a repo by looking at my fork.
Resolves #384.