Skip to content

[feature] Update the README.md #5

@Bobscorn

Description

@Bobscorn

Is your feature request related to a problem? Please describe.
The README.md is quite outdated, containing a lot of old and misleading information. I think it needs a proper update to be actually useful to anyone who doesn't already know how to build, install and work on cpp-engine.

Describe the solution you'd like
README.md should contain updated information about how to properly build the cpp-engine library and its dependencies, and how to build, link and install the accompanying cpp-engine game. The information should be accurate and require as little external information/instructions as possible.

Describe alternatives you've considered
N/A

Additional context
README.md currently contains information from 2 or more previous build setups, and a bunch of outdated instructions for building dependencies. This is mixed in with some more accurate build information at the bottom.
Otherwise the README.md contains other outdated information about build flags, and badly documented 'Config' system.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions