-
Notifications
You must be signed in to change notification settings - Fork 93
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Modernize docs #18
Modernize docs #18
Conversation
Left some more nits to turn this bikeshed into a luxury bike resort. I proof-read the document and think it's fine. Thanks for spending the time to writing it initially, and the continuous improvements! So the only thing left to do before merge (from what I see): Fix the one non-nit review comment (which is confusing), then squash-up into a single commit and adopt commit title style of previous commit ("docs: Modernize README using markdown" or something along those lines). |
a6e488b
to
2a333d5
Compare
I still think the docs are very cluttered after this PR but it's a lot better than the old change log. Here's a "build guide" for MSYS on Windows.
|
e07a34e
to
3fab60e
Compare
3fab60e
to
ab093e2
Compare
-q Run quiet (suppress all non-error output). | ||
-Q Run silent (suppress all output). | ||
-s Skip $SystemUpdate folder. | ||
-v Print version information and exit. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Version information is stale. We should probably add a step that integrates the Git commit-id somehow. [Not an issue with this PR, but still something to be aware of]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Has nothing to do with this PR though.
Create an issue or PR please.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great catch, also agree it is out of scope for this PR. Created an issue to capture @mborgerson's findings: #21
Thanks @DiscoStarslayer ! |
Initial attempt at cleaning up the docs a bit.
Markdown is more standard and a little easier to read, also lets you skip a changelog to figure out how to use it.
See proposed readme formatted here
Closes #1