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

Revise README #7545

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Revise README #7545

wants to merge 4 commits into from

Conversation

regulus79
Copy link
Contributor

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)

  • It mentions a competing DAW in the first sentence and describes LMMS as a free alternative to it.
  • The first paragraph is very informal (uses "you" quite a bit, along with the phrase "You can have fun...")
  • Claims that LMMS is user-friendly and modern (The ui is great, but I wouldn't call it particularly user friendly atm)
  • Flow could be improved ("to create music with your computer. This includes..." could be revised to be more direct)

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.

@thismoon
Copy link

my following suggestions are mainly stylistic but i hope it is still relevant since we're discussing the readme file

  • although the user interface is probably going to change (there are many issues opened about it) it would be nice to have screenshots in the readme to show what the program looks like
  • no need for the "Share your songs!" line since "LMMS Sharing Platform" is clear enough and it's the only link with additional text
  • remove "on our wiki for information on how to build LMMS." from the building section. pointing to a hyperlink is enough
  • the logo and name aren't aligned. maybe make it centered using
<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>
demonstration

image

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>

LMMS Logo
LMMS

Cross-platform music production software

Website ⦁︎ Releases ⦁︎ Developer wiki ⦁︎ User manual ⦁︎ Showcase ⦁︎ Sharing platform

@regulus79
Copy link
Contributor Author

I like it, very professional! I hope you don't mind me copying that and adding it to the PR

@Rossmaxx
Copy link
Contributor

The new readme looks professional, better than what we had. I am not approving for now as there seems to be something missing.

@Rossmaxx
Copy link
Contributor

Rossmaxx commented Oct 28, 2024

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

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.

3 participants