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.

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

No mapping documentation #9

Open
NotMyWing opened this issue Nov 2, 2020 · 2 comments
Open

No mapping documentation #9

NotMyWing opened this issue Nov 2, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@NotMyWing
Copy link
Owner

NotMyWing commented Nov 2, 2020

There should be documentation, either gh-pages or wiki. Preferably wiki.

The docs should outline the basic structure of maps, manifest files, task and sabotage creation.
While the code itself is semi-well documented and readable enough, the base classes of tasks and sabotages should be documented separately.

@NotMyWing NotMyWing added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 2, 2020
@BytewaveMLP
Copy link
Collaborator

I could look into writing some docs if you'd like. Just need collaborator access.

@BytewaveMLP
Copy link
Collaborator

Started some work on this on the wiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants