Skip to content

Improve ReadME #5

@awilliamson

Description

@awilliamson

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions