Skip to content
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

Merged
merged 1 commit into from
Jan 25, 2019
Merged

Conversation

DiscoStarslayer
Copy link
Contributor

@DiscoStarslayer DiscoStarslayer commented Jan 12, 2019

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@JayFoxRox
Copy link
Member

JayFoxRox commented Jan 13, 2019

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).

@DiscoStarslayer DiscoStarslayer force-pushed the modernize-docs branch 2 times, most recently from a6e488b to 2a333d5 Compare January 15, 2019 01:35
@GXTX
Copy link
Contributor

GXTX commented Jan 15, 2019

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.

pacman -S git make mingw-w64-x86_64-cmake mingw-w64-x86_64-gcc
git clone https://github.com/XboxDev/extract-xiso
cd extract-xiso && mkdir build && cd build
cmake .. -G "MSYS Makefiles"
make

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
-q Run quiet (suppress all non-error output).
-Q Run silent (suppress all output).
-s Skip $SystemUpdate folder.
-v Print version information and exit.
Copy link
Member

@mborgerson mborgerson Jan 24, 2019

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]

Copy link
Member

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.

Copy link
Contributor Author

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

@mborgerson mborgerson merged commit fc7fd5c into XboxDev:master Jan 25, 2019
@mborgerson
Copy link
Member

Thanks @DiscoStarslayer !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

5 participants