Skip to content

FtDSharp wiki #10

Description

@trk20

FtDSharp is fairly novel and needs somewhere to put additional documentation, guides, examples, and other relevant information that doesn't fit in the README.

The GitHub wiki for this repository is probably the best option for this, as it's immediately accessible and doesn't require substantial setup.

Rough outline:

  • Main page: introduction, general info like motivation
  • Minimal C# crash course/introduction including setting up workspace (possibly include section on using copilot for users that just want a script that does 'x'?)
  • Documentation for each major part of the API: Constructs, Weapons, Missiles, Subobjects
  • Documentation for additional creature comforts like the included PID class
  • Examples for common use cases
  • General good practice guidelines
  • Section(s) for contributors: current code organization/structure, guide for getting workspace set up and building the mod locally, contribution guidelines/flow

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Projects

    Status
    In Progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions