-
-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Revise README #7545
base: master
Are you sure you want to change the base?
Revise README #7545
Conversation
my following suggestions are mainly stylistic but i hope it is still relevant since we're discussing the readme file
<div align="center">
<h1><img src="https://raw.githubusercontent.com/LMMS/artwork/master/Icon%20%26%20Mimetypes/lmms-64x64.svg" alt="LMMS Logo"><br> LMMS</h1>
</div> or here's an idea of what the whole header could look like (more compact layout and simpler hyperlink labels) codeblock<div align="center">
<h1>
<img
src="https://raw.githubusercontent.com/LMMS/artwork/master/Icon%20%26%20Mimetypes/lmms-64x64.svg"
alt="LMMS Logo"
/><br />LMMS
</h1>
<p>Cross-platform music production software</p>
<p>
<a href="https://lmms.io/">Website</a>
⦁︎
<a href="https://github.com/LMMS/lmms/releases">Releases</a>
⦁︎
<a href="https://github.com/LMMS/lmms/wiki">Developer wiki</a>
⦁︎
<a href="https://lmms.io/documentation">User manual</a>
⦁︎
<a href="https://lmms.io/showcase/">Showcase</a>
⦁︎
<a href="https://lmms.io/lsp/">Sharing platform</a>
</p>
</div>
|
… along with otehr minor changes
I like it, very professional! I hope you don't mind me copying that and adding it to the PR |
The new readme looks professional, better than what we had. I am not approving for now as there seems to be something missing. |
I would like to get opinion on the new readme in this branch from someone with an eye for detail, @RoxasKH mind chiming in? https://github.com/regulus79/lmms/tree/revise-readme here's the link |
The current state of README.md is a bit sub-par, and I think it could really use some revising.
Critique
(some of these critiques are subjective; I don't mean anything against the person who originally wrote the readme, and I myself don't know if I could do much better)
I'm not saying that I am a good enough writer to fix the readme, but what I have in this PR is at least a start.
Please please please critique me and suggest edits.