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

Rework README file #1374

Merged
merged 10 commits into from
Aug 24, 2023
Merged

Rework README file #1374

merged 10 commits into from
Aug 24, 2023

Commits on Aug 14, 2023

  1. Remove 2.x references and add badges

    @rockstorm101
    rockstorm101 committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    85cb345 View commit details
    Browse the repository at this point in the history

  2. Rework main description

    @rockstorm101
    rockstorm101 committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    db0f567 View commit details
    Browse the repository at this point in the history

  3. Move installation and usage sections to the top

    @rockstorm101
    rockstorm101 committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    787e817 View commit details
    Browse the repository at this point in the history

  4. Simplify installation and add PyPI instructions

    @rockstorm101
    rockstorm101 committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    2b505c9 View commit details
    Browse the repository at this point in the history

  5. Remove Ubuntu exception on running from source

    @rockstorm101
    rockstorm101 committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    91e58f0 View commit details
    Browse the repository at this point in the history

  6. Add section explaining the test suite

    @rockstorm101
    rockstorm101 committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    acdef4e View commit details
    Browse the repository at this point in the history

  7. Add a contributing section

    @rockstorm101
    rockstorm101 committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    c479298 View commit details
    Browse the repository at this point in the history

  8. Add a table of contents at the top

    @rockstorm101
    rockstorm101 committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    0f3cd9a View commit details
    Browse the repository at this point in the history

Commits on Aug 16, 2023

  1. Rework run from source section for Linux and macOS

    @rockstorm101
    rockstorm101 committed Aug 16, 2023
    Configuration menu
    Copy the full SHA
    12032bf View commit details
    Browse the repository at this point in the history

Commits on Aug 17, 2023

  1. Fix Windows build due to wrong encoder 

    Getting "UnicodeDecodeError: 'charmap' codec can't decode byte 0x9d in
position 22902: character maps to <undefined>" due to default Windows
encoder (cp1252) not being able to decode current README. Need to force
UTF-8 encoding.
    @rockstorm101
    rockstorm101 committed Aug 17, 2023
    Configuration menu
    Copy the full SHA
    02a1191 View commit details
    Browse the repository at this point in the history