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

readme: document Qemu port. #630

Closed
wants to merge 7 commits into from

Conversation

errordeveloper
Copy link
Contributor

No description provided.

@pfalcon
Copy link
Contributor

pfalcon commented May 27, 2014

Thanks for this patch, but I thought it would be structure a bit different. The top-level README is already pretty big, and really should not grow any more, especially with things not interesting to everyone. Some ports (e.g. windows/) started to add per-port READMEs, and that's how I envisioned it for qemu. I'm also not sure about formatting changes to top README - it should remain to be plain-text readable, and I'm not sure too much markup and non-ascii chars help with that.

Summing up, I would vote for just extracting qemu port description as qemu/README and avoid other changes. I can go for that if there're no objections.

@dpgeorge
Copy link
Member

I agree with @pfalcon's points, especially that the main README (in the root dir) should be as concise as possible.

pfalcon added a commit that referenced this pull request May 29, 2014
@pfalcon
Copy link
Contributor

pfalcon commented May 29, 2014

Thanks for splitting out qemu-arm/README.md, that was merged. I didn't merge the rest, feel free to rebase and resubmit with more advocacy why these changes are needed. But I already commented on formatting changes, and single textual change makes it just more confusing with "both architectures" (if this was a wikipedia edit, it would get "[which?]" mark) and "probably".

@pfalcon pfalcon closed this May 29, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants