Skip to content

Provide documentation and example projects #4

@JayFoxRox

Description

@JayFoxRox

This project desperately needs a README.
I found this after only 2 days of working on my own solution; even then it takes a lot of reading of the code to figure out what it does.

I'd like to see (in the README, wiki, or repository website):

  • Short introduction about what this does (curve-generation, curve-fitting, sprite-rendering).
  • Example input files (ideally a wiki article with a list of all publicly available inputs).
  • Example screenshot of the output.
  • Documentation on how to build the tool.
  • Documentation on how to run this tool.
  • Plans for the future of this tool (integration with OpenRCT2? use within https://github.com/OpenRCT2/OpenGraphics?).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions