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

Configuration and README edits for readability #950

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Configuration and README edits for readability #950

wants to merge 6 commits into from

Commits on Mar 8, 2022

  1. Edited for readability and consistency 

    The comments in the original file are difficult to read with a text editor that is not colour coded due to the amount of single line comments. Users with no coding knowledge will not understand what they are looking at. The layout of comments and settings were also inconsistent from setting to setting. The comments have been updated to more adequately explain what each setting does and collated into a single block comment. The order of settings has also been changed to more logically group related settings. Lastly, a comment at the top of the file explaining how to edit the settings has been added for inexperienced users, with a suggestion to use an editor other than Windows Notepad.
    @SynthGal
    SynthGal committed Mar 8, 2022
    Configuration menu
    Copy the full SHA
    c0e997b View commit details
    Browse the repository at this point in the history

  2. Edited readme to reflect state of wiki 

    The wiki is woefully inadequate, and given the amount of users creating issues that end up being closed with links to the wiki and "RTFM," it's abundantly clear the issue is the lack of proper documentation. The link to the wiki now has clarification that the wiki is still under construction to reflect this.
    @SynthGal
    SynthGal committed Mar 8, 2022
    Configuration menu
    Copy the full SHA
    9c17e57 View commit details
    Browse the repository at this point in the history

  3. Added white border to logo 

    Black logo text on readme page not visible when using dark mode on github web. Added white border to text to increase visibility.
    @SynthGal
    SynthGal committed Mar 8, 2022
    Configuration menu
    Copy the full SHA
    71226da View commit details
    Browse the repository at this point in the history

  4. Reuploaded due to inkscape export mistake

    @SynthGal
    SynthGal committed Mar 8, 2022
    Configuration menu
    Copy the full SHA
    036728f View commit details
    Browse the repository at this point in the history

  5. Fixed typo

    @SynthGal
    SynthGal committed Mar 8, 2022
    Configuration menu
    Copy the full SHA
    7cb320d View commit details
    Browse the repository at this point in the history

  6. Added sentence pointing out config file 

    Some users were not aware there was a config file (Davidobot#534), added a sentence pointing out the existence of this file.
    @SynthGal
    SynthGal committed Mar 8, 2022
    Configuration menu
    Copy the full SHA
    4ad7242 View commit details
    Browse the repository at this point in the history