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.

Sign up for GitHub

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

Jump to bottom

Improve ReadME #5

Open
awilliamson opened this issue Nov 20, 2016 · 1 comment
Open

Improve ReadME #5

awilliamson opened this issue Nov 20, 2016 · 1 comment

Comments

@awilliamson
Copy link

As it stands the ReadMe is somewhat long and wordy. It may aid new, and potentially inexperienced users in installing and configuring the mod if the ReadMe was more concise and user-centric for installation.

The nitty gritty of how rsync works is really of no benefit to the average user; they care about more high-level concepts such as configuration settings, and impact/behaviour to their server.
A section for the 'science' behind why it works may be good, but I recommend this to be left for the end of the ReadMe.

I can possibly PR a new suggestion for the ReadMe at some point if you would like?
@alexbobp
Copy link
Member

Hehe you caught me, I'm no tech writer. I would be very grateful for a PR if you're interested in taking this on!

Like my other small mod, I made this to scratch an itch and how to make it mass market ready is something I'm still learning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@alexbobp @awilliamson